diff --git a/README.md b/README.md index 58beeac..05bd000 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,53 @@ -# Getting Started with Create React App +# Wayfinder This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). -## Available Scripts +## Quick Start -In the project directory, you can run: +Download all the dependencies using NPM: + + ```sh + npm ci + ``` + +Run the app in the development mode: + + ```sh + npm start + ``` + +This will open [http://localhost:3000](http://localhost:3000) to view it in your browser. + +The page will reload when you make changes. You may also see any lint errors in the console. -### `npm start` +When you're finished, you can build a production release by updating the `VERSION.txt` file and running: + +```sh +make build +``` + +This bundles React in production mode and compresses all the files into a versioned tarball inside of the `artifact` directory. Your app is now ready to be deployed! + +## Other Available Commands + +In the project directory, you can run: -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +```sh +make clean +``` -The page will reload when you make changes.\ -You may also see any lint errors in the console. +Removes all versioned tarballs from the `artifact` directory. -### `npm test` +```sh +npm test +``` Launches the test runner in the interactive watch mode.\ See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. -### `npm run build` +```sh +npm run build +``` Builds the app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. @@ -29,7 +57,9 @@ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. -### `npm run eject` +```sh +npm run eject +``` **Note: this is a one-way operation. Once you `eject`, you can't go back!**