From 6ab4978a03c41209af2b0c52c5ee034bba06e796 Mon Sep 17 00:00:00 2001 From: Jeff Avallone Date: Tue, 13 Feb 2018 17:57:03 -0500 Subject: [PATCH] Documenting scripts in README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 611a5b3..2cf3aaf 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,16 @@ To start a development server, run: $ yarn start +### Available scripts + +* `yarn start` - Start a development server on port 8080 +* `yarn start:prod` - Run a build and start a web server on port 8080. This will not automatically rebuild. +* `yarn build` - Run a production build (used for deployments and for rebuilding when running `yarn start:prod`) +* `yarn test` - Run lint and unit tests +* `yarn test:lint` - Run eslint +* `yarn test:unit` - Run jest unit tests +* `yarn test:watch` - Run jest in watch mode + ## License See [LICENSE.txt](/LICENSE.txt) file for licensing details.