Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent 6cc488c commit 71fae7f
Show file tree
Hide file tree
Showing 3 changed files with 112 additions and 12 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) 2014-19 Bloggify <support@bloggify.org> (https://bloggify.org)
Copyright (c) 2014-20 Bloggify <support@bloggify.org> (https://bloggify.org)

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
120 changes: 110 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,50 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


















# `$ bloggify`

[![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)







> We make publishing easy.
















## :cloud: Installation

You can install the package globally and use it as command line tool:
Expand Down Expand Up @@ -34,8 +72,8 @@ Commands:
start Starts the Bloggify process.
Options:
-v, --version Displays version information.
-h, --help Displays this help.
-v, --version Displays version information.
Examples:
$ bloggify start
Expand All @@ -44,18 +82,23 @@ Examples:
Documentation can be found at https://github.com/Bloggify/Bloggify.
```

## :clipboard: Example


Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm` (or `yarn`):

```sh
# Using npm
npm install --save bloggify-cli

# Using yarn
yarn add bloggify-cli
```








## :clipboard: Example



Here is an example how to use this package as library. To install it locally, as library, you can use `npm install bloggify-cli` (or `yarn add bloggify-cli`):



Expand All @@ -74,29 +117,86 @@ app.onLoad(err => {











## :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:





## :memo: Documentation

For full API reference, see the [DOCUMENTATION.md][docs] file.












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
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `todos-app-bloggify`
- `bloggify-starter`











## :scroll: License

[MIT][license] © [Bloggify][website]

[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2014#license-mit





[license]: /LICENSE
[website]: https://bloggify.org
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package.development.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@
"edit-json-file": "^1.3.1",
"execa": "^4.0.0"
}
}
}

0 comments on commit 71fae7f

Please sign in to comment.