Update Documentation - Githubissues

P3KI / bendy

A rust library for encoding and decoding bencode with enforced cannonicalization rules.

BSD 3-Clause "New" or "Revised" License

70 stars 13 forks source link

Closed 0ndorio closed 5 years ago

0ndorio commented 5 years ago

As one of the last steps before we can release v0.2 the documentation must be updated properly.

This request does

use skeptic as dev depdency to ensure all examples in README.md are actually valid.
fix the examples in README.md.
update the content of README.md to include decoding with FromBencode.
add a CHANGELOG.md.

hdznrrd commented 5 years ago

From a user's point of view the changelog reads well and the readme contains all items I'd like to see in a readme :+1: