Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Dec 24, 2017
1 parent 186dab7 commit ac7d247
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ You can install the package globally and use it as command line tool:


```sh
$ npm i -g birthday
# Using npm
npm install --global birthday

# Using yarn
yarn global add birthday
```


Expand Down Expand Up @@ -48,10 +52,14 @@ Documentation can be found at https://github.com/IonicaBizau/birthday
## :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`:
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
$ npm i --save birthday
# Using npm
npm install --save birthday

# Using yarn
yarn add birthday
```


Expand All @@ -75,9 +83,11 @@ 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.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit ac7d247

Please sign in to comment.