Skip to content

Commit 83cdde5

Browse files
committed
fix readme for docs and some badges
1 parent 6e46329 commit 83cdde5

File tree

2 files changed

+12
-23
lines changed

2 files changed

+12
-23
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"private": true,
44
"description": "TypeScript-based various types of solutions for TokenE projects only.",
55
"license": "MIT",
6-
"homepage": "https://dl-tokene.github.io/web-kit",
6+
"homepage": "https://dl-tokene.github.io/webkit",
77
"repository": {
88
"type": "git",
99
"url": "git+https://github.com/dl-tokene/webkit.git"

packages/toolkit/README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,30 @@
1-
# @distributedlab/tools
2-
These packages aim to provide developers with a set of commonly used functions and features for building web applications, such as handling big numbers, date manipulation, subscribing to and receiving notifications when certain events occur with EventEmitter, and more.
1+
# @tokene/toolkit
2+
These packages aim to provide developers with a set of commonly used functions and features for building TokenE web applications, such as handling big numbers, date manipulation, subscribing to and receiving notifications when certain events occur with EventEmitter, and more.
33

44
![version (scoped package)](https://badgen.net/npm/v/@tokene/toolkit)
55
![types](https://badgen.net/npm/types/@tokene/toolkit)
66
![tree-shaking](https://badgen.net/bundlephobia/tree-shaking/@tokene/toolkit)
7-
![checks](https://badgen.net/github/checks/distributed-lab/web-kit/main)
7+
![checks](https://badgen.net/github/checks/dl-tokene/webkit/main)
88

99
## Getting Started
1010

1111
### Installing
1212

1313
```
14-
yarn add @distributedlab/tools
14+
yarn add @tokene/toolkit
1515
```
1616

1717
#### Work with big numbers
1818
```ts
19-
import { BN } from '@distributedlab/tools';
19+
import { IpfsUtil } from '@tokene/toolkit'
2020

21-
const amountA = BN.fromRaw(2, 18)
22-
const amountB = BN.fromRaw(3, 18)
21+
const ipfsEntity = new IpfsUtil({
22+
rawData: JSON.stringify({
23+
someData: 'lorem ipsum dolor sit amet concestetur!',
24+
}),
25+
})
2326

24-
console.log(amountA.add(amountB).format({
25-
decimals: 18,
26-
decimalSeparator: '.',
27-
groupSeparator: ',',
28-
groupSize: 3,
29-
}))
30-
```
31-
32-
#### Work with dates
33-
```ts
34-
import { time } from '@distributedlab/tools';
35-
36-
const currentDate = time()
37-
38-
console.log(currentDate.format('YYYY-MM-DD'))
27+
await ipfsEntity.uploadSelf()
3928
```
4029

4130
## Running the tests

0 commit comments

Comments
 (0)