From f86515ab265a9efc13200e902f9e7e735f5f1499 Mon Sep 17 00:00:00 2001
From: Jack Hadrill <jack@hadrill.co.uk>
Date: Sat, 29 Jan 2022 14:02:24 +0000
Subject: [PATCH] Update readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++--------
 1 file changed, 35 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 9797aa1..241f4fd 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # Romulus-JS
+[![Build Status](https://drone.jacknet.io/api/badges/TerribleCodeClub/romulus-js/status.svg)](https://drone.jacknet.io/TerribleCodeClub/romulus-js) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
 An implementation of the Romulus-M cryptography specification.
 
@@ -11,8 +12,40 @@ Run the following commands from the root of the repository:
 $ npm install
 $ npm run build
 ```
+The build output will be saved to the `dist` directory.
 
-The build output will be saved to the `lib` directory.
+## Contribution guidelines
+
+[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
+
+This library uses [ts-standard](https://github.com/standard/ts-standard), based on [JavaScript Standard Style](https://standardjs.com/rules.html). Please ensure all contributions are ts-standard compliant before submitting a pull request.
+
+## Development instructions
+
+Requirements:
+- The latest LTS builds of Node and npm.
+
+Follow the instructions below to lint, test and build Romulus-JS.
+
+#### Lint
+
+```bash
+$ npm install
+$ npm run lint
+```
+
+#### Test
+
+```bash
+$ npm install
+$ npm run test
+```
+#### Build
+
+```bash
+$ npm install
+$ npm run build
+```
 
 ### Visual Studio Code
 
@@ -20,10 +53,4 @@ This repository contains the necessary configuration files to debug, test and bu
 
 Run the build task (`Ctrl+Shift+B` or `⇧⌘B`) to automatically compile the Typescript source files in the background.
 
-_Debug and test instructions for Visual Studio Code coming soon._
-
-## Contribution
-
-[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
-
-This library uses [ts-standard](https://github.com/standard/ts-standard), based on [JavaScript Standard Style](https://standardjs.com/rules.html). Please ensure all contributions are ts-standard compliant before submitting a pull request.
+Unit tests use the [Jest](https://jestjs.io/) library. Support for Visual Studio Code is offered through the [Jest marketplace package](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest) maintained by Orta.
\ No newline at end of file