litus 1.3.1 → 1.5.0

package/README.md

@@ -1,29 +1,29 @@
 <div align="center">
   <img src="https://raw.githubusercontent.com/estidlore/litus/main/Logo.svg" alt="Logo" width="80" height="80">
   
-  <h2 align="center">Litus</h2>
+  <h2>Litus</h2>
 
-  <p align="center">
-    Lightweight and powerful utils for Typescript with smart type inference
-    <br />
-    <a href="https://github.com/estidlore/litus/issues">Report Bug</a>
-  </p>
+  <p>Lightweight and powerful utilities for Typescript with smart type inference</p>
+  <a href="https://github.com/estidlore/litus/blob/main/docs/docs.md">Docs</a>
 </div>
 
 Litus provides strongly-typed utils for:
 
-- [Arrays](https://github.com/estidlore/litus/blob/main/docs/Array.md)
-- [Functions](https://github.com/estidlore/litus/blob/main/docs/Function.md)
-- [Math](https://github.com/estidlore/litus/blob/main/docs/Math.md)
-- [Objects](https://github.com/estidlore/litus/blob/main/docs/Object.md)
+- Arrays
+- Functions
+- Math
+- Objects
+- Random
+- Strings
 
 ## Why Litus?
 
-- Powerful unique utils (i.e. `math.calc`)
+- Powerful and unique utilities (e.g. `math.calc`)
 - Tree-shakeable (import only what you need)
 - Smart type inference
-- Lightweight (no dependencies)
+- Lightweight
 - 100% test coverage
+- Well-documented
 
 ## Installation
 
@@ -39,13 +39,13 @@ yarn add litus
 
 **Import all utils**
 
-For ES6+ or Typescript
+For ES6+ or Typescript:
 
 ```ts
 import * as _ from "litus";
 ```
 
-For CommonJS
+For CommonJS:
 
 ```js
 var _ = require("litus");
@@ -54,11 +54,11 @@ var _ = require("litus");
 **Import only what you need**
 
 ```ts
-import { arr, func, math, obj } from "litus";
+import { arr, func, math, obj, rand, str } from "litus";
 ```
 
 ```ts
-import { aprox, copy, group, memo } from "litus";
+import { aprox, copy, group, memo, randWeight, template } from "litus";
 ```
 
 ## Contributing
@@ -68,4 +68,4 @@ Don't forget to give the project a star!
 
 ## License
 
-This package released under the [MIT License](https://github.com/estidlore/litus/blob/main/LICENSE).
+This package is released under the [MIT License](https://github.com/estidlore/litus/blob/main/LICENSE).