docs: up @csv-js/csv readme

packages/csv/README.md

@@ -1,8 +1,64 @@
-# @csv-js/csv
-Main module for processing with Csv.
+# CsvJs
+A js library specialized in processing csv data.
 
-## Usage
+## ✨ Features
 
-```
+- Parse csv format
+- Serialized csv format
+- Csv data CRUD
+- Browser download csv
+
+## 📦︎ Packages
+
+- `@csv-js/csv` A class specialized in processing csv data.
+- `@csv-js/core` The core module for processing csv.
+- `@csv-js/type` Generic types for csv-js packsge.
+
+## 👨‍💻 Usage
+
+### Install
+
+```shell
 npm install @csv-js/csv --save
 ```
+
+### Example
+
+```typescript
+import Csv from '@csv-js/csv'
+
+const header = [
+  {
+    key: 'name',
+    label: 'Name'
+  },
+  {
+    key: 'age',
+  }
+]
+const csv = new Csv(header, { name: 'test' })
+
+csv.append([
+  {
+    name: 'eddie',
+    age: 20
+  },
+  {
+    name: 'jojo',
+    age: 18
+  }
+])
+
+csv.toString() // 'Name,age\r\neddie,20\r\njojo,18'
+
+// Browser download csv
+csv.download()
+```
+
+## 📃 Documentation
+
+To be perfected.
+
+## License
+
+Licensed under the [MIT License](LICENSE).

packages/csv/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@csv-js/csv",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Main module for processing with Csv.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",