From 5f3aa7f98101a13e218f70c39ce993102a2ecbb9 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Wed, 19 Sep 2018 14:27:47 -0400 Subject: [PATCH] . --- packages/create-freesewing-pattern/readme.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/create-freesewing-pattern/readme.md b/packages/create-freesewing-pattern/readme.md index d6b940d6ba8..67cb26d4a26 100644 --- a/packages/create-freesewing-pattern/readme.md +++ b/packages/create-freesewing-pattern/readme.md @@ -46,7 +46,7 @@ create-react-library ``` Answer some basic prompts about your module, and then the CLI will perform the following steps: -- copy over the template to a new folder in the current directory +- copy over the template - install dependencies via yarn or npm - link packages together for local development - initialize local git repo @@ -89,7 +89,8 @@ Publish your package to `npm`: npm publish ``` -This will build `cjs` and `es` versions of your module to `dist/`. +This also builds `cjs` and `es` versions of your module to `dist/`. + Make sure that any npm modules you want as peer dependencies are properly marked as `peerDependencies` in `package.json`. The rollup config will automatically recognize them as peers and not try to bundle them in your module. @@ -101,7 +102,7 @@ Deploy your example app to GitHub Pages: npm run deploy ``` -This will create a production build of the example `create-react-app` that showcases your library and then runs `gh-pages` to deploy the resulting bundle. +This creates a production build of the example `create-react-app` that showcases your library and then runs `gh-pages` to deploy the resulting bundle. ## Examples