update readme - adding description

README.md

@@ -1,38 +1,38 @@
-# packageName
+# typescript-adt
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![bundle][bundle-src]][bundle-href]
 [![Codecov][codecov-src]][codecov-href]
 
-This is my package description.
+Experimental abstraction of data structure utils for javascript (browsser/nodejs)
 
 ## Usage
 
 Install package:
 
 ```sh
 # npm
-npm install packageName
+npm install typescript-adt
 
 # yarn
-yarn add packageName
+yarn add typescript-adt
 
 # pnpm
-pnpm install packageName
+pnpm install typescript-adt
 
 # bun
-bun install packageName
+bun install typescript-adt
 ```
 
 Import:
 
 ```js
 // ESM
-import {} from "packageName";
+import {} from "typescript-adt";
 
 // CommonJS
-const {} = require("packageName");
+const {} = require("typescript-adt");
 ```
 
 ## Development
@@ -51,11 +51,11 @@ Published under [MIT License](./LICENSE).
 
 <!-- Badges -->
 
-[npm-version-src]: https://img.shields.io/npm/v/packageName?style=flat&colorA=18181B&colorB=F0DB4F
-[npm-version-href]: https://npmjs.com/package/packageName
-[npm-downloads-src]: https://img.shields.io/npm/dm/packageName?style=flat&colorA=18181B&colorB=F0DB4F
-[npm-downloads-href]: https://npmjs.com/package/packageName
-[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/packageName/main?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-version-src]: https://img.shields.io/npm/v/typescript-adt?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-version-href]: https://npmjs.com/package/typescript-adt
+[npm-downloads-src]: https://img.shields.io/npm/dm/typescript-adt?style=flat&colorA=18181B&colorB=F0DB4F
+[npm-downloads-href]: https://npmjs.com/package/typescript-adt
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/typescript-adt/main?style=flat&colorA=18181B&colorB=F0DB4F
 [codecov-href]: https://app.codecov.io/github/elhakimdev/typescript-abstract-data-type
-[bundle-src]: https://img.shields.io/bundlephobia/minzip/packageName?style=flat&colorA=18181B&colorB=F0DB4F
-[bundle-href]: https://bundlephobia.com/result?p=packageName
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/typescript-adt?style=flat&colorA=18181B&colorB=F0DB4F
+[bundle-href]: https://bundlephobia.com/result?p=typescript-adt

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "dsa-typescript",
+  "name": "typescript-adt",
   "version": "0.0.2",
-  "description": "",
+  "description": "Experimental abstraction of data structure utils for javascript",
   "repository": "https://github.com/elhakimdev/typescript-abstract-data-type",
   "license": "MIT",
   "sideEffects": false,