From f6cf148f59669fa1f648523b47dcd46d161b0d35 Mon Sep 17 00:00:00 2001 From: Haroen Viaene Date: Tue, 3 Nov 2020 09:50:13 +0100 Subject: [PATCH] docs(readme): clarify Yarn fixes #55 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 623c40ff44..204cbca24b 100644 --- a/README.md +++ b/README.md @@ -19,22 +19,24 @@ Edit, preview and share mermaid charts/diagrams. ## Setup -Setup is simple. +This project is set up using [Yarn](https://classic.yarnpkg.com/en/docs/getting-started): ``` yarn install ``` + or in develop branch to use the beta version of mermaid use + ``` yarn install --update-checksums ``` This together with a .npmrc file: + ``` registry=https://registry.npmjs.com/ @mermaid-js:registry=https://npm.pkg.github.com //npm.pkg.github.com/:_authToken="XXXXXXXXX" - ```