diff --git a/README.md b/README.md index 9f661d9..a8e6d7c 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ A unified shared library which aids in building fuzzers for browsers or as compl

JavaScript Style Guide - - - +Build Status +Current Release +Coverage Status IRC

@@ -19,11 +19,12 @@ Octo.js bundles core functions and generic boilerplate code commonly used in mos Octo's future aims to be a stable, well-tested and well-documented standard library for fuzzing in a JavaScript environment. ## Table of Contents + - [Table of Contents](#table-of-contents) - [Playbook](#playbook) - [Usage in Node](#usage-in-node) - [Usage in Browser](#usage-in-browser) - - [Develop](#develop) + - [Development](#development) - [Testing](#testing) - [API Documentation](#api-documentation) @@ -31,7 +32,6 @@ Octo's future aims to be a stable, well-tested and well-documented standard libr https://runkit.com/posidron/octo-js-playbook - ### Usage in Node ``` @@ -43,16 +43,18 @@ const {random} = require('@mozillasecurity/octo') random.init() ``` -### Usage in Browser +### Usage in the Browser ``` +yarn install yarn build ``` -### Develop +A bundled production build (`octo.js`) is placed into the local `dist` directory. + +### Development ```bash -yarn install yarn lint yarn test yarn build @@ -68,7 +70,7 @@ yarn test ### API Documentation -* https:// +- https:// or