# SHARKEY.RS

![GitHub CI](https://github.com/angeldollface/sharkey.rs/actions/workflows/rust.yml/badge.svg)

***A tiny library to work with Sharkey from Rust asynchronously!***

## ABOUT

This repository contains the code for a small Rust crate to work with Sharkey from Rust. Feel free to follow me on Sharkey [here](https://blahaj.zone/@angeldollface666).

## INSTALLATION

### FOR RUST PROJECTS

To use ***Sharkey.rs*** in your Rust project, add this line to your project's `Cargo.toml`:

```TOML
sharkey = "0.1.0"
```

## USAGE

To understand how to use *Sharkey.rs* in your project, please refer to the project's [documentation](https://docs.rs/sharkey/0.1.0). If the documentation does not help you, you can also read the unit tests [here](src/modules/tests.rs).

## FEATURES

- Fully asynchronous.
- Printable responses via `serde_json`.
- Inlcudes all important actions a user may want to perform.

## CHANGELOG

### Version 0.1.0

- Initial release.
- Upload to GitHub.
- Upload to [crates.io](https://crates.io/crates/sharkey).

## NOTE

- *Sharkey.rs* by Alexander Abraham a.k.a. *"Angel Dollface"*
- Licensed under the [DSL v1](https://github.com/angeldollface/doll-software-license).