Skip to content

Commit

Permalink
prepare v1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Langer committed Oct 8, 2016
1 parent b0231e4 commit 596dfdb
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![build status](https://img.shields.io/travis/screeny05/corrode.svg?style=flat-square)](https://travis-ci.org/screeny05/corrode)
[![docs](https://doc.esdoc.org/github.com/screeny05/corrode/badge.svg)](https://doc.esdoc.org/github.com/screeny05/corrode/)

Corrode is a batteries-included library for reading your binary data. It helps you converting that blob-mess into readable data.
Corrode is a batteries-included library for reading binary data. It helps you converting that blob-mess into useable data.

Use it to parse _that one_ obscure binary-file with the help of JavaScript.

Expand All @@ -36,7 +36,7 @@ corrode provides standard read-actions like uint8-uint64 for big & little endian
Additionally you can use assertions to always be sure, the data you parse corresponds to a specified format.
The parsing is done not by a configuration-object, but by imperative code, allowing for far greater flexibility.

corrode is an abstraction on top of nodes `TransformStream` and as such is pipeable to but also provides functions for more simple usage.
corrode is an abstraction on top of `TransformStream` and as such is pipeable to but also provides functions for more simple usage.

This library is not only heavily inspired by [dissolve](https://github.com/deoxxa/dissolve), it in fact can be seen as a total rewrite with even more features.
The code is written in ES7, fully documented and tested.
Expand Down Expand Up @@ -78,7 +78,7 @@ These are just some of the very basic operations supported by Corrode.

## Examples
All examples can be found in the examples/-folder. Included:
* ID3v2.3-Parser - strict, unforgiving parser for a subset of this standard. It needs `npm i image-to-ascii temp` and can be run with `node examples/id3 test.mp3`.
* ID3v2.3-Parser - strict, unforgiving parser for a subset of the standard used to store meta-data in mp3-files. It needs `npm i image-to-ascii temp` and can be run with `node examples/id3 test.mp3`.

If you'd like to include your own examples, just open a PR. I'm more than happy to not have to think about existing complex structured binary data to parse myself.

Expand Down Expand Up @@ -108,7 +108,7 @@ corrode is currently not tested for use in browsers.

## Used dependencies (3)
The following dependencies are installed when installing corrode:
* bl - used for buffering data, in case a job gets gready or you don't want to auto-flush
* bl - used for buffering data, in case a job gets greedy or you don't want to auto-flush
* readable-streams - ensures consistent and stable behaviour of the underlying Transform-Stream
* lodash - several utility functions

Expand Down
2 changes: 1 addition & 1 deletion doc/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Determines the identifier of the temporary variable which gets created when usin
## `encoding`
**default:** `'utf8'`

**accepts:** Any encoding nodes `Buffer.prototype.toString` accepts. [Full list here](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings).
**accepts:** Any encoding `Buffer.prototype.toString` accepts. [Full list here](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings).

Determines which encoding to use for string-functions like `.string()` or `.terminatedString()`. Can be overwitten on a per-use-basis by the functions themselves.

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "corrode",
"version": "0.1.0",
"description": "",
"version": "1.0.0",
"description": "A batteries-included library for reading binary data.",
"main": "dist/index.js",
"scripts": {
"build": "babel src --out-dir dist --source-maps",
Expand All @@ -23,7 +23,7 @@
"bugs": {
"url": "https://github.com/screeny05/corrode/issues"
},
"homepage": "https://github.com/screeny05/corrode#readme",
"homepage": "https://github.com/screeny05/corrode",
"devDependencies": {
"babel-cli": "^6.10.1",
"babel-eslint": "^6.1.0",
Expand Down

0 comments on commit 596dfdb

Please sign in to comment.