diff --git a/HISTORY.md b/HISTORY.md new file mode 100644 index 00000000000..76336fde244 --- /dev/null +++ b/HISTORY.md @@ -0,0 +1,7 @@ +## [v0.1.0] +> Jan 28, 2016 + +- Initial preview release. + +[v0.1.0]: https://github.com/rstacruz/pnpm/blob/v0.1.0 + diff --git a/README.md b/README.md index d57cf56f421..af7825c2b21 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,49 @@ pnpm is a fast implementation of `npm install`. ![](https://raw.githubusercontent.com/rstacruz/pnpm/gh-pages/screencast.gif) + +## Install + +Install it via npm. + +``` +npm install -g pnpm.js +``` + +Use `pnpm` in place of `npm`. It overrides `pnpm i` and `pnpm install`—all other commands will passthru to `npm`. + +``` +pnpm install lodash +``` + +## Preview + +`pnpm` will stay in `<1.0.0` until it's achieved feature parity with `npm install`. + +- [ ] pnpm install + - [x] npm packages + - [ ] GitHub packages + - [ ] @scoped modules + - [ ] tarball packages + - [ ] file packages + - [ ] bin executables + - [ ] `--global` installs + - [ ] `--save` et al +- [ ] pnpm uninstall +- [ ] pnpm ls + +## Acknowledgements + +[ied](https://www.npmjs.com/package/ied) is built on a very similar premise. + +## Thanks + +**pnpm** © 2016+, Rico Sta. Cruz. Released under the [MIT] License.
+Authored and maintained by Rico Sta. Cruz with help from contributors ([list][contributors]). + +> [ricostacruz.com](http://ricostacruz.com)  ·  +> GitHub [@rstacruz](https://github.com/rstacruz)  ·  +> Twitter [@rstacruz](https://twitter.com/rstacruz) + +[MIT]: http://mit-license.org/ +[contributors]: http://github.com/rstacruz/pnpm/contributors diff --git a/package.json b/package.json index 099852d1ff0..92c785510c9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "pnpm", - "version": "1.0.0", + "name": "pnpm.js", + "version": "0.1.0", "description": "", "main": "index.js", "scripts": { @@ -23,6 +23,7 @@ "semver": "5.1.0", "tar-fs": "1.9.0" }, + "preferGlobal": true, "bin": { "pnpm": "bin/pnpm", "pnpm-install": "bin/pnpm-install"