diff --git a/README.md b/README.md index 2f4098f..b2bc08a 100755 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # BRAID v0.8.5 ## Websocket server for the Measure platform ---- [](https://semaphoreci.com/yardstick/braid) ## Essential Information: * braid uses [mocha (test framework)](https://www.npmjs.com/package/mocha), [chai (BDD/TDD assertion library)](https://www.npmjs.com/package/chai), [sinnon (spies, stubs, and mocks)](https://www.npmjs.com/package/sinon), [nyc (code coverage calculator)](https://www.npmjs.com/package/nyc) for our unit testing. Get aquainted with these packages to have a smooth unit testing experience. * For web sockets braid uses [ws](https://www.npmjs.com/package/ws) -* 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 benifitsm drawbacks and dev flow +* 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 ## Local Development * you can see if braid is running by typing in `https://ysbraid.localhost:8443` @@ -31,9 +30,10 @@ payload = { token = JWT.encode payload, hmac_secret, "HS256" ``` +* to test your changes before pushing you can run `compose test` ## Setting up -* download the braid repo into a folder in the same director as the primary yardstick folder +* 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` * `compose stop` stops the default braid container that `vagrant up` builds