README.md in nem-1.0.0 vs README.md in nem-1.0.1

- old
+ new

@@ -1,33 +1,29 @@ -# nem [![[gem]](https://badge.fury.io/rb/nem.svg)](https://badge.fury.io/rb/nem) [![[npm]](https://img.shields.io/npm/v/nem.svg)](https://www.npmjs.com/package/nem) +# nem - Convert simple Ruby .gemspec files to package.jsons [![[gem]](https://badge.fury.io/rb/nem.svg)](https://badge.fury.io/rb/nem) -Contrary to common belief, npm[https://www.npmjs.com/] does not stand for "node package manager". In fact it is a [package make installer](https://docs.npmjs.com/misc/faq#if-npm-is-an-acronym-why-is-it-never-capitalized), which just happens to be written in node. Hence it is not only meant to be used for node (or iojs[https://iojs.org/]) modules. It is also great for command-line tools written in Ruby! +Contrary to common belief, [npm](https://www.npmjs.com/) does not stand for "node package manager". In fact it is a [package make installer](https://docs.npmjs.com/misc/faq#if-npm-is-an-acronym-why-is-it-never-capitalized), which just happens to be written in node. Hence it is not only meant to be used for node (or [iojs](https://iojs.org/)) modules. It is also great for command-line tools written in Ruby! ## Install -Either via rubygems: +Via rubygems: $ gem install nem -Or via npm: +The nem utility used to be published on npm also. Please note that this is not the case anymore and the current nem package is part of another project. - $ npm install -g nem - ## Usage * Build your Ruby CLI gem as usual * Don't use any dependencies (other than included in Ruby's standard library) -* Write your gemspec (example: [nem.gemspec](https://github.com/janlelis/nem/blob/master/nem.gemspec)) +* Write your gemspec (example: [nem.gemspec](https://github.com/janlelis/nem/blob/main/nem.gemspec)) * Run the following command to generate a `package.json` file: - $ nem +``` +$ nem +``` * Optional: Command-line arguments to `nem` will be interpreted as keywords for npm's search * That's it. Only step left: Publish it on the rubygems & npm public registries - -nem's own [package.json](https://github.com/janlelis/nem/blob/master/package.json) was generated by: - - $ nem ruby gem npm ## Install it locally ### Via npm [Instructions](https://docs.npmjs.com/cli/install). In short: