Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating your docs #1

Merged
merged 2 commits into from
Mar 8, 2021
Merged

Updating your docs #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cb2b6c
Add/update properties available in docs for API
brandiw Mar 8, 2021
8865443
Remove --save as it is no longer necessary
brandiw Mar 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
A quick introduction of the minimal setup you need to get a up & running.

```shell
$ npm install --save snake-names
$ npm install snake-names
```

## Usage
Expand Down Expand Up @@ -69,10 +69,13 @@ $ snake-names --help

| Method | Type | Description |
|:-----------------:|:------------:|-------------------------------------------------------------------------------------------------------------------------|
| `.all` | array | List all popular snake names |
| `.allMaleSnake` | array | List all popular male snake names |
| `.allFemaleSnake` | array | List all popular female snake names |
| `.random(n)` | string/array | returns a random snake name if no param is provided . Otherwise, returns an array of random snake names of length `n`. |
| `.all` | array | List all popular snake names |
| `.male` | array | List all popular male snake names |
| `.female` | array | List all popular female snake names |
| `.cute` | array | List all cute snake names |
| `.unique` | array | List all unique snake names |
| `.famous` | array | List all famous snake names |
| `.random(n)` | string/array | returns a random snake name if no param is provided. Otherwise, returns an array of random snake names of length `n`. |

## License

Expand Down