From 2d26688f0427bff27c1b9a90064d8f769e6289d4 Mon Sep 17 00:00:00 2001 From: "g. nicholas d'andrea" Date: Mon, 26 Jun 2017 14:10:37 -0400 Subject: [PATCH] Fix README to use `truffle unbox` command --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ef38f16..4117512 100644 --- a/README.md +++ b/README.md @@ -10,28 +10,23 @@ This box comes with everything you need to start using smart contracts from a re npm install -g ethereumjs-testrpc ``` -2. Clone or download the truffle box of your choice. +2. Downlaod box using Truffle. ```javascript - git clone [repo] + truffle unbox truffle-box-react ``` -3. Install the node dependencies. - ```javascript - npm install - ``` - -4. Compile and migrate the contracts. +3. Compile and migrate the contracts. ```javascript truffle compile truffle migrate ``` -5. Run the webpack server for front-end hot reloading. For now, smart contract changes must be manually recompiled and migrated. +4. Run the webpack server for front-end hot reloading. For now, smart contract changes must be manually recompiled and migrated. ```javascript npm run start ``` -6. Jest is included for testing React components and Truffle's own suite is incldued for smart contracts. Be sure you've compile your contracts before running jest, or you'll receive some file not found errors. +5. Jest is included for testing React components and Truffle's own suite is incldued for smart contracts. Be sure you've compile your contracts before running jest, or you'll receive some file not found errors. ```javascript // Runs Jest for component tests. npm run test @@ -40,7 +35,7 @@ This box comes with everything you need to start using smart contracts from a re truffle test ``` -7. To build the application for production, use the build command. A production build will be in the build_webpack folder. +6. To build the application for production, use the build command. A production build will be in the build_webpack folder. ```javascript npm run build ```