fluffle/README.md

# 🐰 fluffle

Fluffle is a familiar Markdown pastebin-y site :)

## Usage

Once you've cloned the repository, cd into the `app` directory and run `cargo run -r`.

After you start the server the first time, a `fluffle.toml`file will be created in the current directory. You'll need to edit that file to configure your PostgreSQL connection, instance name/theme color, etc.

## Customization

You may notice the `public` and `templates_src` directories inside of `app/`. If you cd into a fresh directory and copy and paste these directories, you're able to edit any file within them and run the binary from that new directory to have it read these files.

You can build (without running) for release using the following command:

```
cargo build -r
```

Once you've built the binary, it'll be located at (from the root `fluffle/` directory) `target/release/fluffle`.

All templates are compiled with [nanoneo](https://trisua.com/t/nanoneo), so it's recommended that you familiarize yourself with that syntax.

You can set a master password to be able to freely edit all entries by using the `master_pass` configuration key. A password is automatically generated on first start as well. Please note that this value is stored in plain text.

## Attribution

Fluffle is licensed under the AGPL-3.0 license. Tetratto is also licensed under the AGPL-3.0 license.