From d6e0786611f60343f29de19138c5f8b231e41394 Mon Sep 17 00:00:00 2001 From: Andre Date: Wed, 6 Sep 2023 19:05:27 +0930 Subject: [PATCH] adding readme --- rescript/README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/rescript/README.md b/rescript/README.md index b20ab1ba..87049b50 100644 --- a/rescript/README.md +++ b/rescript/README.md @@ -1,13 +1,30 @@ +# Gilded Rose +This is the Gilded Rose kata in Rescript with Jest -# Build -``` -npm run build +## Getting started + +Install dependencies + +```sh +yarn install ``` -# Watch +## Running tests -``` -npm run watch +To run all tests + +```sh +yarn test ``` +To run all tests in watch mode + +```sh +yarn test:watch +``` + +To start developing +```sh +yarn dev:rescript +```