Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Jan 6, 2017
1 parent 91439e5 commit fb995e0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 38 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 Ionică Bizău <[email protected]> (http://ionicabizau.net)
Copyright (c) 2016-17 Ionică Bizău <[email protected]> (http://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
46 changes: 9 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,29 @@

# `$ bloggify`

[![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/bloggify-cli.svg)](https://www.npmjs.com/package/bloggify-cli) [![Downloads](https://img.shields.io/npm/dt/bloggify-cli.svg)](https://www.npmjs.com/package/bloggify-cli) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
[![Patreon](https://img.shields.io/badge/Support%20me%20on-Patreon-%23e6461a.svg)][patreon] [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/bloggify-cli.svg)](https://www.npmjs.com/package/bloggify-cli) [![Downloads](https://img.shields.io/npm/dt/bloggify-cli.svg)](https://www.npmjs.com/package/bloggify-cli) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

> CLI for Bloggify.
## :cloud: Installation

You can install the package globally and use it as command line tool:


```sh
$ npm i -g bloggify-cli
```


Then, run `bloggify --help` and see what the CLI tool can do.


```
$ bloggify --help
Usage: bloggify <command> [options]
CLI for Bloggify.
Commands:
start Starts the Bloggify process.
stop Stops the Bloggify process.
Options:
-v, --version Displays version information.
-h, --help Displays this help.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

Examples:
$ bloggify start
$ bloggify stop
$ bloggify start -c path/to/config/file.json

Documentation can be found at https://github.com/Bloggify/bloggify-cli#readme.
```
## :moneybag: Donations

## :memo: Documentation
Another way to support the development of my open-source modules is
to [set up a recurring donation, via Patreon][patreon]. :rocket:

For full API reference, see the [DOCUMENTATION.md][docs] file.
[PayPal donations][paypal-donations] are appreciated too! Each dollar helps.

## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
Thanks! :heart:


## :scroll: License

[MIT][license] © [Ionică Bizău][website]

[patreon]: https://www.patreon.com/ionicabizau
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[donate-now]: http://i.imgur.com/6cMbHOC.png

Expand Down

0 comments on commit fb995e0

Please sign in to comment.