[ls-exports] readme

packages/ls-exports/README.md

@@ -0,0 +1,49 @@
+# ls-exports <sup>[![Version Badge][2]][1]</sup>
+
+[![Build Status][3]][4]
+[![dependency status][5]][6]
+[![dev dependency status][7]][8]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][11]][1]
+
+Given a package name and a version number, or a path to a package.json, what specifiers does it expose?
+
+The package export defaults an `async function`. It fulfills with an object with the following keys:
+  - `name` the package name
+  - `version`: the package version
+  - `engines`: the package's `engines` requirements
+  - `binaries`: the files that are made available as executable programs
+  - `errors`: any validation errors encountered during parsing. <sub>Note that these errors *do not* necessarily interfere with the listed entry points being accessible at runtime.</sub>
+
+For ESM-supporting node versions (at the time of this writing, `^12.17 || >= 13.2`):
+  - `require`: valid specifiers to pass into `require`
+  - `import`: valid specifiers to pass into `import()`, or to use in a static `import` statement
+  - `files`: all files on the filesystem that are directly exposed by the above entry points
+  - `tree`: a hierarchical object structure where each directory is represented as a key containing an object, and each file is represented as a key containing a list of the entry points that expose that file
+
+For node versions prior to ESM support (at the time of this writing, `< 12.17 || ~13.0 || ~13.1`):
+  - `require (pre-exports)`: valid specifiers to pass into `require`
+  - `files (pre-exports)`: all files on the filesystem that are directly exposed by the above entry points
+  - `tree (pre-exports)`: a hierarchical object structure where each directory is represented as a key containing an object, and each file is represented as a key containing a list of the entry points that expose that file
+
+## Example
+
+```sh
+ls-exports resolve@1
+```
+
+[1]: https://npmjs.org/package/ls-exports
+[2]: http://versionbadg.es/ljharb/ls-exports.svg
+[3]: https://travis-ci.com/ljharb/ls-exports.svg
+[4]: https://travis-ci.com/ljharb/ls-exports
+[5]: https://david-dm.org/ljharb/ls-exports.svg
+[6]: https://david-dm.org/ljharb/ls-exports
+[7]: https://david-dm.org/ljharb/ls-exports/dev-status.svg
+[8]: https://david-dm.org/ljharb/ls-exports?type=dev
+[11]: https://nodei.co/npm/ls-exports.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/ls-exports.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/ls-exports.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=ls-exports