From 4e0fd291e52897a2e39bfd3c21ada30c298d0c7d Mon Sep 17 00:00:00 2001 From: Julian Rosse Date: Thu, 26 May 2022 14:38:34 -0400 Subject: [PATCH] small fixes --- docs/src/commands/build.md | 6 +++--- docs/src/contributing.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/src/commands/build.md b/docs/src/commands/build.md index 616fd24..7d6a7c5 100644 --- a/docs/src/commands/build.md +++ b/docs/src/commands/build.md @@ -1,6 +1,6 @@ # wasm-pack build -The `wasm-pack build` command creates the files neccessary for JavaScript +The `wasm-pack build` command creates the files necessary for JavaScript interoperability and for publishing a package to npm. This involves compiling your code to wasm and generating a pkg folder. This pkg folder will contain the wasm binary, a JS wrapper file, your `README`, and a `package.json` file. @@ -22,7 +22,7 @@ path is given, the `build` command will run in the current directory. ## Output Directory -By default, `wasm-pack` will generate a directory for it's build output called `pkg`. +By default, `wasm-pack` will generate a directory for its build output called `pkg`. If you'd like to customize this you can use the `--out-dir` flag. ``` @@ -99,7 +99,7 @@ wasm-pack build --target nodejs ## Scope -The init command also accepts an optional `--scope` argument. This will scope +The `build` command also accepts an optional `--scope` argument. This will scope your package name, which is useful if your package name might conflict with something in the public registry. For example: diff --git a/docs/src/contributing.md b/docs/src/contributing.md index d2a4dac..34f3a6a 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -12,14 +12,14 @@ You'll also want to check out the contributing [guidelines]. ## 🏃‍♀️ Up and Running -1. fork and clone this repository +1. fork and clone the `rustwasm/wasm-pack` repository 2. install [node/npm] 2. `cd wasm-pack` 3. `cargo run`. To test command line arguments you can run `cargo run -- `. ## Documentation -Documentation lives in the `/docs` directory. Each command has it's own page. +Documentation lives in the `/docs` directory. Each command has its own page. Additionally there are extra pages explaining the prerequisites, setup, and how to contribute (which you are reading now!). @@ -28,7 +28,7 @@ contribute (which you are reading now!). Tests live in the `/tests` directory. To run the tests you can run: ``` -cargo test +cargo test ``` You can also manually test the CLI tool by running: