diff --git a/README.md b/README.md index 1c2abf9..2093525 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ -![Logo](https://github.com/posidron/posidron.github.io/raw/master/static/images/octo.png) +

+ Logo +

-[![Build Status](https://api.travis-ci.org/MozillaSecurity/octo.svg?branch=master)](https://travis-ci.org/MozillaSecurity/octo) [![Coverage Status](https://coveralls.io/repos/github/MozillaSecurity/octo/badge.svg?branch=master)](https://coveralls.io/github/MozillaSecurity/octo?branch=master) [![JavaScript Style -Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) -[![IRC](https://img.shields.io/badge/IRC-%23fuzzing-1e72ff.svg?style=flat)](https://www.irccloud.com/invite?channel=%23fuzzing&hostname=irc.mozilla.org&port=6697&ssl=1) -[![Current Release](https://img.shields.io/github/release/mozillasecurity/octo.svg)](https://img.shields.io/github/release/mozillasecurity/octo.svg) -[![Downloads](https://img.shields.io/github/downloads/mozillasecurity/octo/total.svg)](https://img.shields.io/github/downloads/mozillasecurity/octo/total.svg) +

+A unified shared library which aids in building fuzzers for browsers or as complement for an already existing fuzzing framework. +

+

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

-Octo.js is a unified shared library which aids in building fuzzers for browsers or as complement for an already existing fuzzing framework. +Octo.js bundles core functions and generic boilerplate code commonly used in most frameworks for fuzzing browsers. It is designed for the sharing of improvements between our individual fuzzers, and with the purpose of reducing the maintainability of those core features with minimal effort. -It bundles core functions and generic boilerplate code commonly used in most frameworks for fuzzing browsers. It is designed for the sharing of improvements between our individual fuzzers, and with the purpose of reducing the maintainability of those core features with minimal effort. - -Octo's future is a stable, well-tested and well-documented standard library for fuzzing in a JavaScript environment. +Octo's future aims to be a stable, well-tested and well-documented standard library for fuzzing in a JavaScript environment. ## Usage @@ -24,13 +29,19 @@ https://mozillasecurity.github.io/octo/octo.js ```html -https://github.com/mozillasecurity/octo/releases/download/0.1/octo.js +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 -./build.py -l lib -d deploy +npm install +npm run build ``` ## Testing