improve description

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Yarik Leto]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -3,9 +3,12 @@
     <br/>
     💻
     <br />
-    Algorithms and Data Structures
+    Algorithms and Data Structures in TypeScript
     <br />
   </h1>
+  <div>
+    The library has zero dependencies and is written in TypeScript. Works with ES modules, CommonJS, and UMD. It has a high test coverage and is well documented.
+  </div>
   <sup> 
     <br />
     <br />
@@ -33,15 +36,12 @@
     </a>
     <br />
   </sup>
-  <br />
-  <br />
-  <br />
-  <br />
-  <pre>npm i <a href="https://www.npmjs.com/package/algo-ds">algo-ds</a></pre>
-  <br />
-  <br />
-  <br />
 </div>
 
+How to install:
+```bash
+npm i algo-ds
+```
+
 # Data structures
-- [DoublyLinkedList](/src/doubly-linked-list.md)
+- [Doubly linked list](/src/doubly-linked-list.md)

coverage/lcov-report/doubly-linked-list.ts.html

@@ -808,7 +808,7 @@ <h1><a href="index.html">All files</a> doubly-linked-list.ts</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2024-07-04T16:43:57.614Z
+                at 2024-07-09T16:08:12.995Z
             </div>
         <script src="prettify.js"></script>
         <script>

coverage/lcov-report/index.html

@@ -101,7 +101,7 @@ <h1>All files</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2024-07-04T16:43:57.614Z
+                at 2024-07-09T16:08:12.995Z
             </div>
         <script src="prettify.js"></script>
         <script>

package.json

@@ -1,7 +1,14 @@
 {
   "name": "algo-ds",
-  "version": "2.0.5",
-  "description": "Implementations of algorithms and data structures in JS",
+  "version": "2.0.6",
+  "description": "Implementations of algorithms and data structures in TypeScript",
+  "license": "MIT",
+  "author": "Yarik Leto <[email protected]>",
+  "homepage": "https://github.com/yarikleto/algo-ds#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yarikleto/algo-ds"
+  },
   "main": "./build/algo-ds.cjs.js",
   "module": "./build/algo-ds.esm.js",
   "browser": "./build/algo-ds.umd.js",
@@ -13,23 +20,8 @@
     "test": "jest --colors --notify",
     "test:watch": "jest --watch",
     "test:coverage": "npm run test -- --coverage",
-    "test:badges": "npm run test:coverage  && jest-coverage-badges",
-    "npm:publish": "npm run lint && npm run test && npm run build && npm run test:badges && npm publish",
-    "prepublishOnly": "npm run build"
-  },
-  "keywords": [
-    "data structures",
-    "algorithms",
-    "algorithms and data structures",
-    "js",
-    "javascript"
-  ],
-  "author": "Yarik Leto <[email protected]>",
-  "license": "Unlicense",
-  "homepage": "https://github.com/yarikleto/algo-ds#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yarikleto/algo-ds"
+    "test:badges": "npm run test:coverage && jest-coverage-badges",
+    "npm:publish": "npm run lint && npm run test && npm run build && npm run test:badges && npm publish"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -52,5 +44,13 @@
     "ts-jest": "^29.1.5",
     "typescript": "^5.5.3",
     "typescript-eslint": "^7.15.0"
-  }
+  },
+  "keywords": [
+    "data structures",
+    "js",
+    "javascript",
+    "ts",
+    "typescript",
+    "doubly linked list"
+  ]
 }