From 64843dd5a640ffef872514eb3baa3664c9df7d61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20K=C3=BChn?= Date: Sat, 1 Sep 2018 09:35:39 +0200 Subject: [PATCH] add development notes to readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index cce6f93f..fa93596d 100644 --- a/README.md +++ b/README.md @@ -354,6 +354,24 @@ export default { ``` +## Development Setup + +Currently only Yarn is supported for development because of a feature called workspaces we are using here. + +``` bash +# install deps +yarn install + +# serve examples at localhost:3000 +yarn start + +# build dist files for packages +yarn build:packages + +# build dist files for examples +yarn build:examples +``` + ## Contributing Please see [CONTRIBUTING](CONTRIBUTING.md) for details.