added preview builds to readme

This commit is contained in:
Christian Klemm 2019-10-16 22:09:33 +02:00
parent 2348f9d785
commit 8e1672568a
No known key found for this signature in database
GPG Key ID: 57578469FC907C48
1 changed files with 14 additions and 0 deletions

View File

@ -147,6 +147,20 @@ Example: https://unpkg.com/mermaid@7.1.0/dist/
yarn add mermaid
### Preview builds
Preview builds are created automatically for each release. They can be found in the [GitHub registry](https://github.com/knsv/mermaid/packages).
Make sure to configure npm to use the GitHub package registry. Steps for that can be found [here](https://help.github.com/en/articles/configuring-npm-for-use-with-github-package-registry).
If you want to get the latest preview for the next release
```
yarn add @knsv/mermaid
```
If you want to get the latest preview for a specific version
```
yarn add @knsv/mermaid@<version>
```
## Documentation