From a5a68d53aff572780ef1e3545344b65ff9316805 Mon Sep 17 00:00:00 2001 From: Christoph Diehl <1614333+posidron@users.noreply.github.com> Date: Thu, 22 Mar 2018 18:32:29 +0100 Subject: [PATCH] Update README.md --- README.md | 40 +++++++++++++++++----------------------- package.json | 2 +- 2 files changed, 18 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index a4c1623..4aaf101 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

@@ -18,41 +18,37 @@ 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. +## Note +The ES6 branch is under active development while we are incorporating it with our existing fuzzers. + + +## Playbook + +https://runkit.com/posidron/octo-js-playbook + ## Node ``` -npm i @mozillasecurity/octo --save-dev +npm i @mozillasecurity/octo ``` ``` const {random} = require('@mozillasecurity/octo') +random.init() ``` ## Browser +We have not yet merged ES6 to master, hence the browser version which was released on master is not up-to-date. +Use the `dist/octo.js` version of this branch by running the following command. + ``` npm run build ``` -```html - -https://mozillasecurity.github.io/octo/octo.js - -``` - -```html - -https://github.com/mozillasecurity/octo/releases/download/0.0.3/octo.js -``` - -```html - -https://cdn.jsdelivr.net/gh/MozillaSecurity/octo@0.0.3/deploy/octo.js -``` - ## Development ```bash @@ -70,7 +66,5 @@ The automated tests are run in Firefox or Chrome using [Karma](https://karma-run To run the automated tests: ```bash -npm install -CHROME_BIN=chromium npm test +npm test ``` -When adding new files, add them in `index.html` and `karma.conf.js` so they can be tested and included in coverage reports. diff --git a/package.json b/package.json index 2551879..50cefb4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mozillasecurity/octo", - "version": "1.0.10", + "version": "1.0.11", "description": "", "keywords": [ "fuzzing",