diff --git a/README.md b/README.md index a99365b..c6f3e67 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,20 @@ -# plume_ynh -Federated blogging application https://github.com/Plume-org/Plume +# Plume for Yunohost +Federated blogging application. + +Shipped version: **0.2.0(Alpa 1)** + +## Interesting links + +- [YunoHost project](https://yunohost.org) +- [Plume Github page](https://github.com/Plume-org/Plume) +- [Demo instance of Plume](https://baptiste.gelez.xyz/) + +## Instruction + +1. The app require dedicated domain like plume.domain.tld +1. Updated is not yet implimented yet. +1. You have to run cargo run and answer the qestions. + **$ cd /var/www/plume && cargo run** +1. The app will need to run inside **Screen** or **tmux** till the systemd gets implimented. + -Now working