diff options
| author |  Vijay A <vraravam@users.noreply.github.com> | 2022-04-23 08:25:24 -0500 |
|---|---|---|
| committer | Vijay A <vraravam@users.noreply.github.com> | 2022-04-23 08:25:24 -0500 |
| commit | 7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4 (patch) | |
| tree | 16b255f0e57af69aa5c55c9c1201b44d0c62e60c /docs | |
| parent | build: add pnpm version to package.json#engines (diff) | |
| download | ferdium-recipes-7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4.tar.gz ferdium-recipes-7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4.tar.zst ferdium-recipes-7a28603912fc705f6ff3ea9e0fa4d22d96ca99a4.zip | |
Use 'pnpm' instead of 'pnpm run'
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/integration.md | 6 | ||||
| -rw-r--r-- | docs/updating.md | 2 |
2 files changed, 4 insertions, 4 deletions
diff --git a/docs/integration.md b/docs/integration.md index 87ffb40..c31e767 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
| @@ -45,15 +45,15 @@ pnpm i | |||
| 45 | 45 | ||
| 46 | ```Bash | 46 | ```Bash |
| 47 | # Make sure you are still in the repository's folder | 47 | # Make sure you are still in the repository's folder |
| 48 | pnpm run create "Service Name" | 48 | pnpm create "Service Name" |
| 49 | ``` | 49 | ``` |
| 50 | 50 | ||
| 51 | Replace `Service Name` with the name of your service, e.g. `pnpm run create "Google Hangouts"`. | 51 | Replace `Service Name` with the name of your service, e.g. `pnpm create "Google Hangouts"`. |
| 52 | This command will automatically create the development recipe in the correct folder, prepares it for your service and opens the new recipe in your file explorer or Finder. 5. Reload Ferdium (`CMD/CTRL + SHIFT + R`) in order for it to register the new recipe 6. You can now develop your recipe as described below. Please continue down below with "[Publishing](#Publishing)" after you are done creating your recipe. | 52 | This command will automatically create the development recipe in the correct folder, prepares it for your service and opens the new recipe in your file explorer or Finder. 5. Reload Ferdium (`CMD/CTRL + SHIFT + R`) in order for it to register the new recipe 6. You can now develop your recipe as described below. Please continue down below with "[Publishing](#Publishing)" after you are done creating your recipe. |
| 53 | 53 | ||
| 54 | 5. (Mandatory) Please run the following step before raising a PR: | 54 | 5. (Mandatory) Please run the following step before raising a PR: |
| 55 | ```Bash | 55 | ```Bash |
| 56 | pnpm run package | 56 | pnpm package |
| 57 | ``` | 57 | ``` |
| 58 | Fix any issues that are reported. | 58 | Fix any issues that are reported. |
| 59 | 59 | ||
diff --git a/docs/updating.md b/docs/updating.md index b5d35c3..3b835df 100644 --- a/docs/updating.md +++ b/docs/updating.md | |||
| @@ -31,6 +31,6 @@ Ferdium uses this version to determine if it should update the local copy of the | |||
| 31 | 31 | ||
| 32 | ## 5. Running the validation checks | 32 | ## 5. Running the validation checks |
| 33 | 33 | ||
| 34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm run package` command to ensure that all validation checks are run. | 34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm package` command to ensure that all validation checks are run. |
| 35 | 35 | ||
| 36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> | 36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> |