From 8e1672568a666afaae07ba713b70e4b8913eb32a Mon Sep 17 00:00:00 2001 From: Christian Klemm Date: Wed, 16 Oct 2019 22:09:33 +0200 Subject: [PATCH] added preview builds to readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index b7372ce37..0d3e6c394 100644 --- a/README.md +++ b/README.md @@ -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@ +``` ## Documentation