Published May 20, 2020 | Version 1.0
Dataset Open

NPM Package READMEs

  • 1. University of Adelaide

Description

This JSON file contains README information for 925, 317 NPM packages. Package README information was downloaded by:

  1. Using https://github.com/nice-registry/all-the-package-names to get a list of all package names.
  2. For each package, looking at the readme field on https://registry.npmjs.org/<package>
  3. Where packages were missing a readme field, sometimes the readme is instead in the versions field. We look for the latest version with a readme field.
  4. Where the package has no readme field at all, we use the repository field to look for common README file names in the github repo.

For 1106544 packages, 925, 317 have a README file.

The JSON file is formatted as follows:

{
  "<name>": "<readme>",
  "<name>": "<readme>"
}

 

Files

readmes.zip

Files (666.7 MB)

Name Size Download all
md5:890771b26513b264f522c69c6817161f
666.7 MB Preview Download