Skip to content

Commit f606649

Browse files
committed
Add readme section on NPM scripts
1 parent 6842ec4 commit f606649

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,14 @@ GitHub will create a new clone under your account, and then you can get started
2525
5. Run `npm start` to run the script.
2626

2727
Now you can head over to our [developer documentation](https://developers.notion.com/) for more information on using the Notion API!
28+
29+
## NPM Scripts
30+
31+
This template has a few built-in NPM scripts:
32+
33+
| Script | Action |
34+
| - | - |
35+
| `npm start` | Run `index.ts`. |
36+
| `npm run typecheck` | Type check using the TypeScript compiler. |
37+
| `npm run format` | Format using Prettier (also recommended: the [Prettier VS Code extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) if you're using VS code.) |
38+
| `npm run build` | Build JavaScript into the `dist/` directory. You normally shouldn't need this if you're using `npm start`. |

0 commit comments

Comments
 (0)