Skip to content

Commit 9bc9bdf

Browse files
author
sashafromlibertalia
committed
finished readme
1 parent b610005 commit 9bc9bdf

1 file changed

Lines changed: 30 additions & 3 deletions

File tree

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,34 @@
11
<p align="center">
2-
Randomzier
2+
<img src="https://raw.githubusercontent.com/websect-itmo/assets/main/Randomzier.png?token=AIY5ZP33HDRXDXFNTFMMZU3A3RPSY">
33
<br>
44
<strong>🎲 Random number generator written in TypeScript</strong>
5-
<p>
6-
<h1>Usage</h1>
5+
</p>
6+
7+
<div align="center">
8+
<img src="https://img.shields.io/npm/dm/randomzier">
9+
<img src="https://img.shields.io/npm/v/randomzier">
10+
</div>
11+
12+
## Installation
13+
14+
`npm i randomzier`
15+
16+
## Usage
17+
```js
18+
const { Randomzier } = require("Randomzier")
19+
const zier = new Randomzier()
20+
21+
console.log(zier.generate())
22+
```
23+
24+
25+
## Features
26+
⚡️ **Easy to use**: randomzier uses simple methods and built-in error handler. Nothing won't go wrong.
27+
<br>
28+
❤️ **Good algorithm**: LCG algorithm is a basis for randomzier.
29+
30+
## License
31+
Randomzier uses [Apache License](https://github.com/websect-itmo/randomzier/blob/main/LICENSE)
32+
33+
734

0 commit comments

Comments
 (0)