Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dsebastien committed May 14, 2024
1 parent 16ba466 commit dd4efb9
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions TEMPLATE_USAGE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Usage

- Copy this project
- Use this project as a template
- Modify package.json (name, description, scripts, PLUGIN_NAME, etc)
- Modify the plugin name in manifest.json
- Modify the plugin name in .github/workflows/release.yml
- Install the project dependencies using ´npm install`
- Run `npx nx connect` to generate a Nx Cloud access token, add, commit and push the changes. After that, make sure to connect the workspace to your Nx cloud organization
- Grant Read/Write access for workflows (pipelines). Go to https://github.com/<user>/<project>/settings/actions and select "Read and write permissions" under "Workflow permissions"
- Remove this file: TEMPLATE_USAGE.md

For the first release, don't use `npm version ...`. Simply call `git tag 1.0.0` and push that tag.
WARNING: For the first release, don't use `npm version ...`. Simply call `git tag 1.0.0` and push that tag.

0 comments on commit dd4efb9

Please sign in to comment.