TerribleCodeClub/romulus-js
12
0
Fork 0
Code Issues 2 Pull Requests Projects 1 Releases 1 Wiki Activity

Update readme
Some checks failed
continuous-integration/drone/push Build is failing
Details

Browse Source
This commit is contained in:
Jack Hadrill 2022-01-29 14:02:24 +00:00
parent 2dedbba5b7
commit f86515ab26
1 changed files with 35 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -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.