aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 83ff032..905e5a9 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,12 @@ You have an idea of a tool? Submit a [feature request](https://github.com/Corent
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
+### Node version
+Ensure you have the correct node/npm version
+```sh
+nvm use
+```
+
### Project Setup
```sh
@@ -44,6 +50,15 @@ npm run test
npm run lint
```
+### Create a new tool
+To create a new tool, there is a script that generate the boilerplate of the new tool, simply run:
+
+```sh
+node scripts/create-tool.mjs my-tool-name
+```
+
+It will create a directory in `src/tools` with the correct files, and a the import in `src/tools/index.ts`. You will just need to add the inported tool in the proper category and develop the tool.
+
## Credits
Coded with ❤️ by [Corentin Thomasset](//corentin-thomasset.fr).