hamcha/octo-deno
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
posidron 2018-09-18 03:53:01 +02:00
parent e1e4dcf5c4
commit 06547fee4c
No known key found for this signature in database
GPG key ID: 799CE5B68FEF404A
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -8,9 +8,9 @@ A unified shared library which aids in building fuzzers for browsers or as compl
<p align="center"> <p align="center">
<a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"></a> <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="JavaScript Style Guide"></a>
<!--<a href="https://travis-ci.org/MozillaSecurity/octo"><img src="https://api.travis-ci.org/MozillaSecurity/octo.svg?branch=es6" alt="Build Status"></a>--> <a href="https://travis-ci.org/MozillaSecurity/octo"><img src="https://api.travis-ci.org/MozillaSecurity/octo.svg?branch=master" alt="Build Status"></a>
<!--<a href="https://img.shields.io/github/release/mozillasecurity/octo.svg"><img src="https://img.shields.io/github/release/mozillasecurity/octo.svg" alt="Current Release"></a>--> <a href="https://img.shields.io/github/release/mozillasecurity/octo.svg"><img src="https://img.shields.io/github/release/mozillasecurity/octo.svg" alt="Current Release"></a>
<!--<a href="https://coveralls.io/github/MozillaSecurity/octo?branch=es6"><img src="https://coveralls.io/repos/github/MozillaSecurity/octo/badge.svg?branch=es6" alt="Coverage Status"></a>--> <a href="https://coveralls.io/github/MozillaSecurity/octo?branch=master"><img src="https://coveralls.io/repos/github/MozillaSecurity/octo/badge.svg?branch=master" alt="Coverage Status"></a>
<a href="https://www.irccloud.com/invite?channel=%23fuzzing&amp;hostname=irc.mozilla.org&amp;port=6697&amp;ssl=1"><img src="https://img.shields.io/badge/IRC-%23fuzzing-1e72ff.svg?style=flat" alt="IRC"></a> <a href="https://www.irccloud.com/invite?channel=%23fuzzing&amp;hostname=irc.mozilla.org&amp;port=6697&amp;ssl=1"><img src="https://img.shields.io/badge/IRC-%23fuzzing-1e72ff.svg?style=flat" alt="IRC"></a>
</p> </p>
@ -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. 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](#table-of-contents) - [Table of Contents](#table-of-contents)
- [Playbook](#playbook) - [Playbook](#playbook)
- [Usage in Node](#usage-in-node) - [Usage in Node](#usage-in-node)
- [Usage in Browser](#usage-in-browser) - [Usage in Browser](#usage-in-browser)
- [Develop](#develop) - [Development](#development)
- [Testing](#testing) - [Testing](#testing)
- [API Documentation](#api-documentation) - [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 https://runkit.com/posidron/octo-js-playbook
### Usage in Node ### Usage in Node
``` ```
@ -43,16 +43,18 @@ const {random} = require('@mozillasecurity/octo')
random.init() random.init()
``` ```
### Usage in Browser ### Usage in the Browser
``` ```
yarn install
yarn build yarn build
``` ```
### Develop A bundled production build (`octo.js`) is placed into the local `dist` directory.
### Development
```bash ```bash
yarn install
yarn lint yarn lint
yarn test yarn test
yarn build yarn build
@ -68,7 +70,7 @@ yarn test
### API Documentation ### API Documentation
* https:// - https://
or or