Skip to content

Commit 7f08d1a

Browse files
committed
style: Readme
1 parent 46bab76 commit 7f08d1a

29 files changed

+59
-9290
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
# higher-or-lower-npm
1+
# Higher or Lower
2+
3+
> Higher or Lower is a simple npm package build around the popular game **Higher or Lower**! HigherLower is being developed and maintained by [Dominik Development](https://github.com/Dominik-Development) and its contributors.
4+
5+
## Installation
6+
7+
Install higherlower with npm
8+
9+
```bash
10+
npm install higherlower
11+
```
12+
13+
Install higherlower with yarn
14+
15+
```bash
16+
yarn add higherlower
17+
```
18+
19+
## Code Example
20+
21+
```js
22+
const HigherOrLower = require("higherlower");
23+
24+
console.log(HigherOrLower.random());
25+
```
26+
27+
## Example output
28+
29+
```js
30+
{
31+
keyword: 'Teacher Training',
32+
searchVolume: 22200,
33+
author: 'yacobcuk',
34+
link: 'http://www.istockphoto.com/photo/professor-writing-on-the-chalkboard-gm496949954-78817003',
35+
image: 'teacher-training.jpg'
36+
}
37+
```
38+
39+
## Methods
40+
41+
- **`random()`**:
42+
Get a random higher/lower dataset.

docs/higher-or-lower/0.0.1/HigherOrLower.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/higher-or-lower/0.0.1/data/search.json

Lines changed: 0 additions & 1 deletion
This file was deleted.
-95.6 KB
Binary file not shown.
-127 KB
Binary file not shown.
-188 KB
Binary file not shown.

0 commit comments

Comments
 (0)