chore: add the readme doc

README.md

@@ -25,5 +25,18 @@ yarn install ts-tree-tools
 // commonjs
 const TTs = require('ts-tree-tools')
 
-//
+// es6
+import TTs from 'ts-tree-tools'
 ```
+
+### Usage
+
+#### API
+
+| Methods | Description |
+| ----    | ----        |
+| toTree   | convert the list structure to tree structure |
+| toList      | convert the tree structure to list structure |
+| findNodeById       | find the first node by id in the tree |
+| findNodeByFunc    | find the first node by call function in the tree |
+| findAllNode | find the all nodes by call function in the tree |

eslint.config.js

@@ -1,6 +1,6 @@
 import antfu from '@antfu/eslint-config'
 
 export default antfu({
-  ignores: ['**.js', 'dist', 'node_modules'],
+  ignores: ['**.js', 'dist', 'node_modules', 'README.md'],
   javascript: false,
 })

src/index.ts

@@ -23,7 +23,7 @@ function getConfig(config: Partial<Config>): Config {
 
 export const TTs = {
   /**
-   *
+   * @description convert the list structure to tree structure
    * @param list the list structure
    * @param config the tree config which you want to convert
    * @returns return the tree structure
@@ -48,7 +48,7 @@ export const TTs = {
     return result
   },
   /**
-   *
+   * @description convert the tree structure to list structure
    * @param tree the tree structure
    * @param config the list config which you want to convert
    * @returns return the list structure