[actions] add submodule and update README

yanyiwu · Jul 16, 2024 · dbeafba · dbeafba
1 parent db984c7
commit dbeafba
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/.github/workflows/npm_publish.yml b/.github/workflows/npm_publish.yml
@@ -9,6 +9,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          submodules: recursive
       - uses: actions/setup-node@v2
         with:
           node-version: '18'

diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ console.log(nodejieba.textRankExtract("升职加薪，当上CEO，走上人生
 + `node v14`
 + `node v15`
 
-## Development
+## Development(Using NodeJieba Library in your own project)
 
 create repo:
 
@@ -159,6 +159,14 @@ console.log(nodejieba.cut("你好世界"))
 node test.js
 ```
 
+## Develop NodeJieba
+
+```sh
+git clone --recurse-submodules https://github.com/yanyiwu/nodejieba.git
+cd nodejieba
+npm install
+npm test
+```
 
 ## 应用