Skip to content

Commit

Permalink
Merge pull request #8 from notkyoyo/canary
Browse files Browse the repository at this point in the history
Updated readme, workflow and version
  • Loading branch information
NotKyoyo authored Apr 13, 2021
2 parents 65e8427 + d1ad90f commit e5f636a
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:

strategy:
matrix:
node-version: [10.x, 12.x, 14.x, 15.x]
node-version: [14.x]

steps:
- uses: actions/checkout@v2
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Need support? _[Click here](https://discord.gg/yyW389c)_

## Installation:

#

### NPM

```bash
Expand All @@ -21,15 +19,15 @@ $ yarn add anime-facts
```

### Query parameters _[ OPTIONAL ]_
#

| Parameters | Type | Description |
| :-------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| tags | `String` | Filter random fact by tag(s). Takes a list of one or more tag names, separated by a comma (meaning `AND`) or a pipe (meaning `OR`). A comma separated list will match facts that have **_all_** of the given tags. While a pipe (`\|`) separated list will match facts that have **_either_** of the provided tags.| |
| minLength | `Int` | The minimum Length in characters ( can be combined with `maxLength` ) | |
| maxLength | `Int` | The maximum Length in characters ( can be combined with `minLength` ) |

## Usage:
#


```javascript
const { getFact } = require("anime-facts");
Expand All @@ -51,13 +49,11 @@ getFact(null, 1, 100).then((fact) => console.log(fact));
```

## Functions
#
| **Functions** | **Description** | **Usage** |
| :-----------: | ---------------------------- | ------------------ |
| getFact | Generate random anime facts. | `random.getFact()` |

## Credits
#
[@LamkasDev](https://github.com/LamkasDev) for adding facts to prior database. _PR [#1](https://github.com/notkyoyo/anime-facts/pull/1)_\
[@xMercyTheDeveloper](https://github.com/xMercyTheDeveloper) for adding a fact to prior database. _PR [#2](https://github.com/notkyoyo/anime-facts/pull/2)_\
[@Lioness100](https://github.com/Lioness100) for adding types and improving codes in version [2.2.6](https://www.npmjs.com/package/anime-facts/v/2.2.6). _PR [#3](https://github.com/notkyoyo/anime-facts/pull/3) and [#4](https://github.com/notkyoyo/anime-facts/pull/4)_
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "anime-facts",
"version": "3.2.6",
"version": "3.2.7",
"description": "Generate random anime facts.",
"main": "index.js",
"types": "index.d.ts",
Expand Down

0 comments on commit e5f636a

Please sign in to comment.