# Writus

[![crates.io](http://meritbadge.herokuapp.com/writus)](https://crates.io/crates/writus)

[Installation](https://github.com/PENGUINLIONG/Writus/wiki/Get-Writus-Online) | [Configuration](https://github.com/PENGUINLIONG/Writus/wiki/Configure-Writus) | [API Documentation](https://github.com/PENGUINLIONG/Writus/wiki/API-Docs)

File-based blog based on Writium Framework.

## How to Use

1. Install Writus: `cargo install writus`;
2. Run Writus: `writus`.

Although all the APIs *work*, as described in the [docs](https://github.com/PENGUINLIONG/Writus/wiki/API-Docs), it's worth spending some time [configuring](https://github.com/PENGUINLIONG/Writus/wiki/Configure-Writus) Writus.

## Customize

Writus has no finished views. The views need to be customized with page templates, otherwise you can see nothing via your browser. Please refer to [this wiki page](https://github.com/PENGUINLIONG/Writus/wiki/Templates) for more information. A example front-end project will be released soon.