From f8c4de091c31e5ee94d850c873ec9c69f336a5a5 Mon Sep 17 00:00:00 2001 From: brmnjsh Date: Sun, 2 Feb 2020 22:03:55 -0500 Subject: [PATCH] Update README.md updating for new information and more clarity --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3676aac..07d8980 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# BRAID v1.2 +# BRAID v1.2.1 > Websocket server for the Measure platform [![Build Status](https://semaphoreci.com/api/v1/projects/7767f0f3-4da6-4c84-9167-4db5402a3262/2573412/badge.svg)](https://semaphoreci.com/yardstick/braid) @@ -16,7 +16,7 @@ * run `npm install` * download the braid repo into a folder in the same directory as the primary yardstick folder -## Building to Docker Hub +## Building to Docker Hub (**this has been retired, new methodolgy will be outlined soon**) * run `./build` * when complete you'll see something like this `Your new docker tag: yardstick/braid:tagid` * copy this tag id, and in the yardstick `docker-compose.yml` file change the `image` field to have the new tag, for example: @@ -35,8 +35,8 @@ braid: * `compose stop` stops the default braid container that `vagrant up` builds * `compose rm braid` removes the default braid container * `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 default braid build container + * `compose build braid` builds the braid image based on the latest transpiled javascript files + * `comopose up -d` starts the braid container based on the files in the braid folder, overriding the default braid build container * you can see if braid is running by typing in `https://ysbraid.localhost` * to connect to braid you need to use the url `wss://ysbraid.localhost?token={token}` * the token is generated in the application that you're connecting to the braid app with (currently only measure has an implementation for this) @@ -60,4 +60,5 @@ payload = { token = JWT.encode payload, hmac_secret, "HS256" ``` -* to test your changes before pushing you can run `npm test` +* to test your changes before pushing you can run `tsc && npm test` +* to check code coverate run nyc npm test, we must maintain above 90% code coverage