![Code Coverage](https://github.com/fatalcenturion/Fudge/workflows/Code%20Coverage/badge.svg) ![Security audit](https://github.com/fatalcenturion/Fudge/workflows/Security%20audit/badge.svg) ![Rust](https://github.com/fatalcenturion/Fudge/workflows/Rust/badge.svg)

Fudge is an Object-Relational Mapping crate for the Rust environment

### Installation
This crate is a library, as such it can be installed by adding the following to your `Cargo.toml`

```toml
[dependancies]
fudge = "*"
```
Once you have done that, you can use the library in your project by adding
```rust
use fudge::Fudge;
```

### Usage

You can read full documentation [here](https://fatalcenturion.github.io/Fudge/target/doc/fudge/index) or alternatively, read basic docs blow.

Connecting to the database:
```rust
let database = Fudge::new("username", "password", "database", "host", 3306 /* port: default is 3306 for MySql*/);
```

Querying the database:
```rust
let result = database.query_raw("SOME SQL QUERY")?;
```

**due to the current status of Fudge**, there is no:
<ul>
SQL query compiler,
</ul>
<ul>
no query optimization,
</ul>
<ul>
no query construction utils
</ul>
<ul>
no dynamic query routing
</ul>
and no protection against:
<ul>
SQL Injection
</ul>
<ul>
Cartesian Explosions
</ul>


Changelog:\
Version 0.0.0 -> 0.0.1

Feature | Status | Issue | Comment
:---: | :---: | :---: | :---:
[Fudge (struct)](https://fatalcenturion.github.io/Fudge/target/doc/fudge/struct.Fudge) | Created | N/A |This is the struct around which the module rotates
[FudgeOptions (struct)](https://fatalcenturion.github.io/Fudge/target/doc/fudge/struct.FudgeOptions) | Created | N/A | Used internally for structs::Fudge

[View previous changelogs](https://fatalcenturion.github.io/Fudge/changelogs/all)