style: Readme

rivo-gg · Apr 23, 2023 · 7f08d1a · 7f08d1a
1 parent 46bab76
commit 7f08d1a
Show file tree

Hide file tree

Showing 29 changed files with 59 additions and 9,290 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,42 @@
-# higher-or-lower-npm
+# Higher or Lower
+
+> 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.
+
+## Installation
+
+Install higherlower with npm
+
+```bash
+  npm install higherlower
+```
+
+Install higherlower with yarn
+
+```bash
+  yarn add higherlower
+```
+
+## Code Example
+
+```js
+const HigherOrLower = require("higherlower");
+
+console.log(HigherOrLower.random());
+```
+
+## Example output
+
+```js
+{
+  keyword: 'Teacher Training',
+  searchVolume: 22200,
+  author: 'yacobcuk',
+  link: 'http://www.istockphoto.com/photo/professor-writing-on-the-chalkboard-gm496949954-78817003',
+  image: 'teacher-training.jpg'
+}
+```
+
+## Methods
+
+- **`random()`**:
+  Get a random higher/lower dataset.
diff --git a/docs/higher-or-lower/0.0.1/HigherOrLower.html b/docs/higher-or-lower/0.0.1/HigherOrLower.html
diff --git a/docs/higher-or-lower/0.0.1/data/search.json b/docs/higher-or-lower/0.0.1/data/search.json
diff --git a/docs/higher-or-lower/0.0.1/fonts/Inconsolata-Regular.ttf b/docs/higher-or-lower/0.0.1/fonts/Inconsolata-Regular.ttf
diff --git a/docs/higher-or-lower/0.0.1/fonts/OpenSans-Regular.ttf b/docs/higher-or-lower/0.0.1/fonts/OpenSans-Regular.ttf
diff --git a/docs/higher-or-lower/0.0.1/fonts/WorkSans-Bold.ttf b/docs/higher-or-lower/0.0.1/fonts/WorkSans-Bold.ttf