From 1f06d5a03ddfa80f5ea2b0e6a5f350838e1b22e9 Mon Sep 17 00:00:00 2001 From: Anartz Mugika Date: Thu, 15 Nov 2018 16:20:50 +0100 Subject: [PATCH] Add project readme with info --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4611f27 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Info about library + +This library will serve to generate lists of random numbers with the specified length,... + +# Installation + +```sh +npm install random-int-list --save +``` + +# Usage + +## JS + +```sh +var t = require('random-int-list'); +console.log(t.randomIntList(5, 1, 5)); +``` + +Result => [ 1, 3, 5, 4, 2] + +## Typescript + +```typescript +import { randomIntList } from 'random-int-list'); +console.log(randomIntList(5, 1, 5)); +``` + +Result => [ 1, 3, 5, 4, 2] \ No newline at end of file