Skip to content

Commit 48a47c3

Browse files
committed
Update README.md
1 parent 321036b commit 48a47c3

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Constant-time algorithms written in TypeScript.
44

5-
[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dsoatok%26type%3Dpatrons&style=for-the-badge)](https://patreon.com/soatok)
5+
[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dsoatok%26type%3Dpatrons&style=for-the-badge)](https://patreon.com/soatok)
66
[![Linux Build Status](https://travis-ci.org/soatok/constant-time-js.svg?branch=master)](https://travis-ci.org/soatok/constant-time-js)
77
[![npm version](https://img.shields.io/npm/v/constant-time-js.svg)](https://npm.im/constant-time-js)
88

@@ -11,6 +11,30 @@ Do not use this in production, especially if you don't have the budget for a cry
1111

1212
![Mind Blowing, right?](https://soatok.files.wordpress.com/2020/08/soatoktelegrams2020-01.png)
1313

14+
## Installing and Usage
15+
16+
Simply add `constant-time-js` to your dependencies section. One way to do this is with `npm`:
17+
18+
```terminal
19+
npm install --save constant-time-js
20+
```
21+
22+
Next, you can import the modules you need.
23+
24+
For JavaScript users:
25+
26+
```js
27+
const { compare, bignum } = require('constant-time-js');
28+
```
29+
30+
Tor TypeScript users:
31+
32+
```typescript
33+
import { compare, bignum } from 'constant-time-js';
34+
```
35+
36+
Please refer to the documentation below for what each function/class does.
37+
1438
## Documentation
1539

1640
This is just a quick outline of what each function does.

0 commit comments

Comments
 (0)