Procházet zdrojové kódy

Merge pull request #294 from iheyunfei/docs_0331

* docs: Improve description of usage
* Fix CI
LongYinan před 3 roky
rodič
revize
4928da1ccc
2 změnil soubory, kde provedl 8 přidání a 1 odebrání
  1. 1 1
      .github/workflows/CI.yml
  2. 7 0
      README.md

+ 1 - 1
.github/workflows/CI.yml

@@ -46,7 +46,7 @@ jobs:
               docker pull $DOCKER_REGISTRY_URL/napi-rs/napi-rs/nodejs-rust:lts-debian
               docker tag $DOCKER_REGISTRY_URL/napi-rs/napi-rs/nodejs-rust:lts-debian builder
             build: |
-              docker run --rm -v ~/.cargo/git:/root/.cargo/git -v ~/.cargo/registry:/root/.cargo/registry -v $(pwd):/build -w /build builder yarn build && strip *.node
+              docker run --rm -v ~/.cargo/git:/root/.cargo/git -v ~/.cargo/registry:/root/.cargo/registry -v $(pwd):/build -w /build builder yarn build --target x86_64-unknown-linux-gnu && strip *.node
           - host: ubuntu-latest
             target: x86_64-unknown-linux-musl
             architecture: x64

+ 7 - 0
README.md

@@ -4,6 +4,13 @@
 
 > Template project for writing node package with napi-rs.
 
+# Usage
+
+1. Click __Use this template__.
+2. __Clone__ your project.
+3. Run `yarn install` to install dependencies.
+4. Run `npx napi rename [name]` command under the project folder to rename your package.
+
 ## Install this test package
 
 ```