@raikuxq/alg-ds 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,28 +1,25 @@
|
|
|
1
|
-
|
|
1
|
+
# @raikuxq/alg-ds
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Common algorithms and data structures written in **TypeScript**, tested with **Jest**.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
[](https://www.npmjs.com)
|
|
6
|
+
[](https://bundlephobia.com)
|
|
7
|
+
[](https://github.com)
|
|
8
|
+
---
|
|
7
9
|
|
|
10
|
+
## Documentation
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
Detailed documentation is available at:
|
|
13
|
+
[raikuxq-algorithms.netlify.app/guide](https://raikuxq-algorithms.netlify.app)
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Installing
|
|
10
18
|
Install by using any of these commands:
|
|
11
19
|
+ `yarn add @raikuxq/alg-ds`
|
|
12
20
|
+ `npm install @raikuxq/alg-ds --save`
|
|
13
21
|
|
|
14
22
|
|
|
15
|
-
# Usage as repository
|
|
16
|
-
|
|
17
|
-
Clone this repository and install dependencies by using `yarn` command.
|
|
18
|
-
+ `yarn test` - run all tests via jest
|
|
19
|
-
+ `yarn dev` - run in dev mode via nodemon (src/index.ts is an entrypoint)
|
|
20
|
-
+ `yarn build` - compile ts sources into js files
|
|
21
|
-
+ `yarn start` - build and run in production mode
|
|
22
|
-
+ `yarn lint` - lint check via eslint
|
|
23
|
-
+ `yarn lint:fix` - fix source files via eslint
|
|
24
|
-
|
|
25
|
-
|
|
26
23
|
# Navigation
|
|
27
24
|
+ [Algorithms](#algorithms)
|
|
28
25
|
+ [Utils](#utils)
|