diff --git a/README.md b/README.md index 82cfb61..3ecc4fe 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ - -[![blah](http://i.imgur.com/at4TK2R.png)](#) @@ -14,90 +12,50 @@ +![blah](http://i.imgur.com/at4TK2R.png) -# `$ blah` - [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/blah.svg)](https://www.npmjs.com/package/blah) [![Downloads](https://img.shields.io/npm/dt/blah.svg)](https://www.npmjs.com/package/blah) +# `$ blah` +A command line tool to optimize the repetitive actions. -> A command line tool to optimize the repetitive actions. +## Installation +```sh +$ npm i blah +``` +### CLI Usage +You can install the package globally and use it as command line tool: +```sh +$ npm i -g blah +``` +Then, run `blah --help` and see what the CLI tool can do. -## :cloud: Installation -You can install the package globally and use it as command line tool: -```sh -# Using npm -npm install --global blah +## Example -# Using yarn -yarn global add blah -``` -Then, run `blah --help` and see what the CLI tool can do. +Here is an example how to use this package as library. -``` -$ blah --help -Usage: blah [options] -A command line tool to optimize the repetitive actions. -Commands: - init Inits the .blah directory. - -Options: - -f, --force When running `blah` without any arguments, force - overriding existing files. - -c, --contributing Generates the CONTRIBUTING.md. - -d, --docs Generates the markdown documentation - (DOCUMENTATION.md) for input file. - -l, --license Generates a LICENSE file with copyright - information. - -g, --gitignore Creates the .gitignore file. - -r, --readme Creates the README.md file. - -b, --bump-version Bumps the package.json version. - -h, --help Displays this help. - -v, --version Displays version information. - -Examples: - $ blah --readme # generates README.md - $ blah --gitignore # generates .gitignore - $ blah --license mit # writes the MIT license in the LICENSE file - $ blah --docs index.js # generates DOCUMENTATION.md from index.js, parsing JSDoc comments - $ blah --bump-version major # bumps the major field of version, in package.json file - -The templates directories that can contain templates based on which the -files -README.md, .gitignore, DOCUMENTATION.md and CONTRIBUTING.md are created, -are -searched in the following order: local .blah directory, -~/.blah-templates, -library templates. The library templates are always -available. - -Happy Blahing! - -Documentation can be found at https://github.com/IonicaBizau/blah. -``` -## :clipboard: Example -Here is an example how to use this package as library. To install it locally, as library, you can use `npm install blah` (or `yarn add blah`): ```js // Dependencies @@ -115,57 +73,34 @@ blh.gitignore(function (err) { blh.license("KINDLY", function (err) { // Do something after creating the license }); + ``` -## :question: Get Help -There are few ways to get help: - 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. - 2. For bug reports and feature requests, open issues. :bug: - 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: -## :memo: Documentation -For full API reference, see the [DOCUMENTATION.md][docs] file. +## Documentation -## :yum: How to contribute -Have an idea? Found a bug? See [how to contribute][contributing]. -## :sparkling_heart: Support my projects -I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, -this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it). +For full API reference, see the [DOCUMENTATION.md][docs] file. -However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: - - Starring and sharing the projects you like :rocket: - - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: - - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone). - - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` - ![](https://i.imgur.com/z6OQI95.png) -Thanks! :heart: +## How to contribute +Have an idea? Found a bug? See [how to contribute][contributing]. -## :scroll: License -[MIT][license] © [Ionică Bizău][website] +## License +See the [LICENSE][license] file. [license]: /LICENSE -[website]: https://ionicabizau.net [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md -[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg -[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg -[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg -[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg -[patreon]: https://www.patreon.com/ionicabizau -[amazon]: http://amzn.eu/hRo9sIZ -[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 36a879c..03fd150 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "blah", - "version": "4.0.1", + "version": "4.0.2", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 7c5ad9a..0897799 100644 --- a/package.json +++ b/package.json @@ -78,4 +78,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}