Skip to content

Commit

Permalink
Merge branch 'module'
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Nov 13, 2014
2 parents 43e6cbc + a51c3ac commit d9dd188
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit d9dd188

Please sign in to comment.