-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38 from behzadam/37-update-readme
docs: update readme
- Loading branch information
Showing
1 changed file
with
42 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,41 @@ | ||
# Yotils is TypeScript utility library | ||
# Yotils is a collection of TypeScript utility functions | ||
|
||
With Yotils, you can effortlessly handle common tasks such as array manipulation, object manipulation, string operations, functional programming, and more. Each utility function is carefully crafted to be efficient, reliable, and easy to integrate into your projects. | ||
|
||
![GitHub top language](https://img.shields.io/github/languages/top/behzadam/yotils) | ||
![GitHub](https://img.shields.io/github/license/behzadam/yotils) | ||
|
||
Utilities: | ||
## Getting Started | ||
|
||
```bash | ||
npm i yotils | ||
``` | ||
|
||
## Local | ||
|
||
```bash | ||
git clone https://github.com/behzadam/yotils.git | ||
``` | ||
|
||
Install dependencies | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
Run tests | ||
|
||
```bash | ||
npm test | ||
``` | ||
|
||
Build | ||
|
||
```bash | ||
npm build | ||
``` | ||
|
||
## Utilities | ||
|
||
- [areSame](src/are-same.ts) | ||
- [countItems](src/count-items.ts) | ||
|
@@ -26,3 +58,11 @@ Utilities: | |
- [omitBy](src/omit-by.ts) | ||
- [toChunks](src/to-chunks.ts) | ||
- [wrapInArray](src/wrap-in-array.ts) | ||
|
||
## License | ||
|
||
The "TypeScript Algorithms, Data Structures and Patterns" repository is licensed under the [MIT License](https://opensource.org/licenses/MIT). Feel free to use, modify, and distribute the code as per the terms of the license. | ||
|
||
## Contact | ||
|
||
If you have any questions or suggestions regarding the repository, please feel free to [contact me](mailto:[email protected]). |