Skip to content
This repository was archived by the owner on Dec 20, 2024. It is now read-only.
/ codec Public archive

Update README#31

Merged
ralphtheninja merged 10 commits intomasterfrom
readme
May 12, 2018
Merged

Update README#31
ralphtheninja merged 10 commits intomasterfrom
readme

Conversation

@ralphtheninja
Copy link
Copy Markdown
Member

Closes #28

@ralphtheninja ralphtheninja requested a review from vweevers May 12, 2018 08:22
Comment thread package.json
"test": "tape test/*.js && standard"
},
"engines": {
"node": ">=4"
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updating node version in another PR.

Comment thread README.md Outdated
The `type` string should be a unique name.

## License & copyright
## License & Copyright
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or just "License"

Comment thread README.md Outdated
## API

### Codec([opts])
### `const codec = Codec([opts])`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why const? Doesn't mean anything here, I think.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No reason.

Comment thread README.md
This could be something like
### `codec.encodeKey(key[, opts])`

```js
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add an Example section

Comment thread README.md Outdated
### `codec.createStreamDecoder([opts])`

Create a function with signature `(key, value)`, that for each key/value pair returned from a levelup read stream returns the decoded value to be emitted.
Create a function with signature `(key, value)`, that for each key/value pair returned from a levelup read stream returns the decoded value to be emitted.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

key/value pair => key-value pair

@ralphtheninja ralphtheninja merged commit 399aeb5 into master May 12, 2018
@ralphtheninja ralphtheninja deleted the readme branch May 12, 2018 10:32
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants