extra-random-addon 1.0.2 → 1.0.4

package/README.md

@@ -1,19 +1,78 @@
-extra-random-addon
-a simple package with simple "random" functions.
-How to Install
-In your specified terminal:
-  npm install extra-random-addon
-Usage
-  import { randint ,minimum, maximum, randrandint, rand_colour_rgb, rand_colour_hex, choice } from "extra-random-addon"
-API
-  randint(min,max) // returns an integer in between min and max (both included)
-  minimum // shorthand for -999999999999999
-  maximum // shorthand for 999999999999999
-  randrandint() // randint(min,max), but the min and max are both decided with a randint() function
-  rand_colour_rgb()¹ // returns three values that are all decided with randint(0,255)
-  rand_colour_hex()¹ // returns a random 7-character hex code
-  choice(array) // returns a random item inside the array
-License
+#extra-random-addon
+
+A simple package with simple "random" functions.
+
+##How to Install
+
+Install the package using npm:
+
+```npm install extra-random-addon```
+
+##Usage
+
+Import the functions you need:
+
+```import {randint,minimum,maximum,randrandint,rand_colour_rgb,rand_colour_hex,choice} from "extra-random-addon"```
+
+##API
+###randint(min, max)
+
+Returns a random integer between min and max, including both values.
+
+```randint(1, 10);```
+
+###minimum
+
+A shorthand constant for:
+
+```-999999999999999```
+
+###maximum
+
+A shorthand constant for:
+
+```999999999999999```
+
+###randrandint()
+
+Returns a random integer where both the minimum and maximum values are themselves randomly generated using randint().
+
+```randrandint();```
+
+###rand_colour_rgb()
+
+Returns a random RGB colour. Each value is generated using randint(0, 255).
+
+```rand_colour_rgb();```
+
+
+For example:
+
+```[124, 37, 201]```
+
+###rand_colour_hex()
+
+Returns a random 7-character hexadecimal colour code.
+
+```rand_colour_hex();```
+
+
+For example:
+
+```#7fc2a1```
+
+###choice(array)
+
+Returns a random item from the provided array.
+
+```choice(["apple", "banana", "orange"]);```
+
+##Licence
+
 ISC
 
-¹ yes it's spelt 'colour' not 'color'
+¹ yes, it's spelt "colour", not "color". 
+
+##PS
+
+I had to release a couple of versions just to get this layout right.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extra-random-addon",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Some extra 'random' features to make coders' lives easier.",
   "main": "./index.js",
   "files": [
@@ -22,6 +22,6 @@
   "license": "ISC",
   "type": "module",
   "dependencies": {
-    "extra-random-addon": "^1.0.1"
+    "extra-random-addon": "^1.0.3"
   }
 }