diff --git a/README.md b/README.md index d133c51..bdf5bfa 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,14 @@ $ npm install $ ./blah.js --version ``` +## How to use + +After you have `package.json` file you can run `blah readme` to generate a README.md file with information taken from package.json and parsed documentation from code. + +To generate the `LICENSE` file (let's create a file containing MIT license), use use `blah license mit`. + +To generate documentation for a specific file, run `blah docs your-file.js`. + ## Help ```sh @@ -94,5 +102,13 @@ Returns the content of the LICENSE by providing the `@licenseName`. 4. Open a pull request, and reference the initial issue in the pull request message. +## Changelog + +### `1.0.0` + - First stable release. + +### `0.0.x` + - Prereleases. + ## License See the [LICENSE](./LICENSE) file. diff --git a/package.json b/package.json index 5dee101..748e671 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "blah", - "version": "0.0.14", + "version": "1.0.0", "description": "A command line tool to optimize the repetitive actions.", "main": "index.js", "scripts": {