binary-reader
-------------
[![Crates][CratesIOBadge]][CratesIO]
[![MIT License][LicenseBadge]][License]
[![Documentation][DocsRsBadge]][DocsRs]
[![Dependency Status][DepsRsBadge]][DepsRs]

[![Continuous Integration][GithubActionsBadge]][GithubActions]
[![FOSSA Status][FOSSAShieldBadge]][FOSSAShield]
[![Codecov Coverage Status][CodecovBadge]][Codecov]
<!--[![Coveralls Coverage Status][CoverallsBadge]][Coveralls]-->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg)](#contributors)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

A binary reader for rust-lang. for step by step.
It's a minimal `byteorder` wrapper for read bytes.

Example
-------
See [examples](examples/) folder.

TODO
----
 * Reference Document
 * Code Optimize
 * More tests and examples

Contributors
------------
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/MPThLee"><img src="https://avatars.githubusercontent.com/u/26970092?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MPThLee</b></sub></a><br /><a href="https://github.com/MPThLee/binary-reader.rs/commits?author=MPThLee" title="Code">💻</a></td>
    <td align="center"><a href="https://github.com/evayde"><img src="https://avatars.githubusercontent.com/u/25255815?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Enrico Gruner</b></sub></a><br /><a href="https://github.com/MPThLee/binary-reader.rs/commits?author=evayde" title="Code">💻</a></td>
    <td align="center"><a href="https://bugadani.github.io/"><img src="https://avatars.githubusercontent.com/u/977627?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dániel Buga</b></sub></a><br /><a href="https://github.com/MPThLee/binary-reader.rs/commits?author=bugadani" title="Code">💻</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

LICENSE
-------
[The MIT License (MIT)](LICENSE.md)

[![FOSSA Status][FOSSALargeBadge]][FOSSALarge]


[CratesIO]: https://crates.io/crates/binary-reader
[CratesIOBadge]: https://img.shields.io/crates/v/binary-reader.svg

[License]: https://github.com/MPThLee/binary-reader.rs/blob/master/LICENSE.md
[LicenseBadge]: https://img.shields.io/github/license/MPThLee/binary-reader.rs.svg

[DocsRs]: https://docs.rs/binary-reader
[DocsRsBadge]: https://docs.rs/binary-reader/badge.svg

[DepsRs]: https://deps.rs/repo/github/mpthlee/binary-reader.rs
[DepsRsBadge]: https://deps.rs/repo/github/mpthlee/binary-reader.rs/status.svg

[FOSSAShield]: https://app.fossa.com/projects/git%2Bgithub.com%2FMPThLee%2Fbinary-reader.rs?ref=badge_shield
[FOSSAShieldBadge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2FMPThLee%2Fbinary-reader.rs.svg?type=shield
[FOSSALarge]: https://app.fossa.com/projects/git%2Bgithub.com%2FMPThLee%2Fbinary-reader.rs?ref=badge_large
[FOSSALargeBadge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2FMPThLee%2Fbinary-reader.rs.svg?type=large

[GithubActions]: https://github.com/MPThLee/binary-reader.rs/actions/workflows/ci.yml
[GithubActionsBadge]: https://github.com/MPThLee/binary-reader.rs/actions/workflows/ci.yml/badge.svg

<!-- Coverage -->
[Codecov]: https://codecov.io/gh/MPThLee/binary-reader.rs
[CodecovBadge]: https://codecov.io/gh/MPThLee/binary-reader.rs/branch/master/graph/badge.svg?token=uFbO1DSJvd

<!--[Coveralls]: https://coveralls.io/github/MPThLee/binary-reader.rs?branch=master
[CoverallsBadge]: https://coveralls.io/repos/github/MPThLee/binary-reader.rs/badge.svg?branch=master
-->