# uuid64rs
[![ci](https://github.com/Dragonrun1/uuid64rs/workflows/ci/badge.svg)](https://github.com/Dragonrun1/uuid64rs/actions)
[![codecov](https://codecov.io/gh/Dragonrun1/uuid64rs/branch/main/graph/badge.svg)](https://codecov.io/gh/Dragonrun1/uuid64rs)
[![Crates.io](https://img.shields.io/crates/v/uuid64rs)](https://crates.io/crates/uuid64rs)
[![dependency status](https://deps.rs/repo/github/dragonrun1/uuid64rs/status.svg)](https://deps.rs/repo/github/dragonrun1/uuid64rs)
<br>
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
[![Crates.io](https://img.shields.io/crates/l/uuid64rs)](https://github.com/Dragonrun1/uuid64rs/blob/main/README.md#licenses)

UUID v4 (random) Rust crate with an additional custom base 64 encoding which is
web and database friendly.

## Table Of Contents

* [Getting Started](#getting-started)
* [Using The Crate](#using-the-crate)
* [Examples](#examples)
* [Contributing](#contributing)
* [Licenses](#licenses)

## Getting Started

TODO

## Using The Crate

TODO

## Examples

TODO

## Contributing

How to contribute:

* :bug: Bug reports - Insects are fine but not in our software.
* :star_struck: Pull requests - Finding and fixing the bug are even better.
* :thinking: Feature requests - Always interest in hear ideas to make things better.
* :hugs: Improving the docs - Easy way to start contributing.

If you are looking at doing any of these things make sure you have a look at our
[CONTRIBUTING] docs.

## Licenses

All code is licensed under either of the

  * [APACHE] - Apache License, Version 2.0
  * [MIT] - MIT License

at your option.

You can find copies of the licenses in the [LICENSE-APACHE] and the
[LICENSE-MIT] files.
All documentation like this README is licensed under the Creative Commons
Attribution-ShareAlike 4.0 International License (CC-BY-SA).
You can find a copy of the [CC-BY-SA] license in the [LICENSE-CC-BY-SA] file.

[APACHE]: https://opensource.org/licenses/Apache-2.0
[CC-BY-SA]: http://creativecommons.org/licenses/by-sa/4.0/
[Cargo.toml]: https://doc.rust-lang.org/cargo/guide/dependencies.html
[CONTRIBUTING]: CONTRIBUTING.md
[Contributor Covenant Code of Conduct]: CODE_OF_CONDUCT.md
[LICENSE-APACHE]: LICENSE-APACHE
[LICENSE-CC-BY-SA]: LICENSE-CC-BY-SA
[LICENSE-MIT]: LICENSE-MIT
[MIT]: https://opensource.org/licenses/MIT
[Rust]: https://www.rust-lang.org/
[cargo-edit]: https://crates.io/crates/cargo-edit

<hr>
Copyright &copy; 2020, Michael Cummings<br/>
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
<img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" />
</a>