diff --git a/README.md b/README.md index 0d4319b..677c775 100755 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ * braid uses [typescript](https://www.npmjs.com/package/typescript) for our primary code development because of it's opinionated type management among other things. Get a good understanding of what typescript is, it's benifits, drawbacks, and dev flow ## Setting up +* install (npm)[https://www.npmjs.com/get-npm] +* install typescript globally (`npm i -g typescript`). This is important because it is needed to transcompile, so you can run your changes, locally (using command `tsc`) * download the braid repo into a folder in the same directory as the primary yardstick folder * `vagrant up` in the primary yardstick folder * run the command `compose stop braid && compose rm braid && tsc && compose build braid && compose up -d` @@ -17,7 +19,7 @@ * `tsc` transpiles the typescript in braid into javascript * `compose build braid` builds the braid container based on the latest transpiled javascript files * `comopose up -d` builds the braid container based on the files in the braid folder, overriding the defaul braid build container - + ## Building to Docker Hub * run `./build` * when complete you'll see something like this `Your new docker tag: yardstick/micro-services:braid-tagid`