Skip to content

Commit a46cc57

Browse files
doc: add instructions to use via npm directly from github
1 parent 0c4d999 commit a46cc57

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,14 @@ Success! 🚀
4545
## Usage
4646

4747
At the moment `notion-markdown-cms` is meant to be consumed via its node.js API from build scripts
48-
wrapping your favourite static site generator tool. You can find an example
49-
script below. Consult the [SyncConfig](./src/SyncConfig.ts) reference for documentation of available configuration options.
48+
wrapping your favourite static site generator tool. Since we're not publishing to npm yet, add it to your project directly from github
49+
50+
```bash
51+
npm add "git+ssh://git@github.com:meshcloud/notion-markdown-cms.git#main"
52+
```
53+
54+
You can find an example build script using the node.js API below.
55+
Consult the [SyncConfig](./src/SyncConfig.ts) reference for documentation of available configuration options.
5056

5157
> A CLI tool could be made available later.
5258

0 commit comments

Comments
 (0)