From a2bc297f0e950a725c5f1627974cd36b5759408b Mon Sep 17 00:00:00 2001
From: Rafael Caricio <rafael@caricio.com>
Date: Thu, 27 Apr 2023 22:00:02 +0200
Subject: [PATCH] Update readme

---
 README.md | 53 +++++++++++++++++++++++++++--------------------------
 1 file changed, 27 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index 71e9677..856be5b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
-# Reef
+# FediMovies
+[![status-badge](https://ci.caric.io/api/badges/FediMovies/fedimovies/status.svg)](https://ci.caric.io/FediMovies/fedimovies)
 
-Lively federated micro-blogging platform.
+Lively federated movies reviews platform.
 
 Built on [ActivityPub](https://www.w3.org/TR/activitypub/) protocol, self-hosted, lightweight. Part of the [Fediverse](https://en.wikipedia.org/wiki/Fediverse).
 
@@ -13,8 +14,8 @@ Features:
 
 ## Instances
 
-- [FediList](http://demo.fedilist.com/instance?software=reef)
-- [Fediverse Observer](https://reef.fediverse.observer/list)
+- [FediList](http://demo.fedilist.com/instance?software=fedimovies)
+- [Fediverse Observer](https://fedimovies.fediverse.observer/list)
 
 Demo instance: https://nullpointer.social/ ([invite-only](https://nullpointer.social/about))
 
@@ -44,53 +45,53 @@ Run:
 cargo build --release --features production
 ```
 
-This command will produce two binaries in `target/release` directory, `mitra` and `mitractl`.
+This command will produce two binaries in `target/release` directory, `fedimovies` and `fedimoviesctl`.
 
 Install PostgreSQL and create the database:
 
 ```sql
-CREATE USER mitra WITH PASSWORD 'mitra';
-CREATE DATABASE mitra OWNER mitra;
+CREATE USER fedimovies WITH PASSWORD 'fedimovies';
+CREATE DATABASE fedimovies OWNER fedimovies;
 ```
 
-Create configuration file by copying `contrib/mitra_config.yaml` and configure the instance. Default config file path is `/etc/mitra/config.yaml`, but it can be changed using `CONFIG_PATH` environment variable.
+Create configuration file by copying `contrib/fedimovies_config.yaml` and configure the instance. Default config file path is `/etc/fedimovies/config.yaml`, but it can be changed using `CONFIG_PATH` environment variable.
 
-Put any static files into the directory specified in configuration file. Building instructions for `mitra-web` frontend can be found at https://codeberg.org/silverpill/mitra-web#project-setup.
+Put any static files into the directory specified in configuration file. Building instructions for `fedimovies-web` frontend can be found at https://code.caric.io/FediMovies/fedimovies#project-setup.
 
-Start Mitra:
+Start Fedimovies:
 
 ```shell
-./mitra
+./fedimovies
 ```
 
-An HTTP server will be needed to handle HTTPS requests. See the example of [nginx configuration file](./contrib/mitra.nginx).
+An HTTP server will be needed to handle HTTPS requests. See the example of [nginx configuration file](./contrib/fedimovies.nginx).
 
-To run Mitra as a systemd service, check out the [systemd unit file example](./contrib/mitra.service).
+To run Fedimovies as a systemd service, check out the [systemd unit file example](./contrib/fedimovies.service).
 
 ### Debian package
 
-Download and install Mitra package:
+Download and install Fedimovies package:
 
 ```shell
-dpkg -i mitra.deb
+dpkg -i fedimovies.deb
 ```
 
 Install PostgreSQL and create the database:
 
 ```sql
-CREATE USER mitra WITH PASSWORD 'mitra';
-CREATE DATABASE mitra OWNER mitra;
+CREATE USER fedimovies WITH PASSWORD 'fedimovies';
+CREATE DATABASE fedimovies OWNER fedimovies;
 ```
 
-Open configuration file `/etc/mitra/config.yaml` and configure the instance.
+Open configuration file `/etc/fedimovies/config.yaml` and configure the instance.
 
-Start Mitra:
+Start Fedimovies:
 
 ```shell
-systemctl start mitra
+systemctl start fedimovies
 ```
 
-An HTTP server will be needed to handle HTTPS requests. See the example of [nginx configuration file](./contrib/mitra.nginx).
+An HTTP server will be needed to handle HTTPS requests. See the example of [nginx configuration file](./contrib/fedimovies.nginx).
 
 ### Tor federation
 
@@ -109,7 +110,7 @@ docker-compose up -d
 Test connection:
 
 ```shell
-psql -h localhost -p 55432 -U mitra mitra
+psql -h localhost -p 55432 -U fedimovies fedimovies
 ```
 
 ### Run web service
@@ -129,7 +130,7 @@ cargo run
 ### Run CLI
 
 ```shell
-cargo run --bin mitractl
+cargo run --bin fedimoviesctl
 ```
 
 ### Run linter
@@ -150,15 +151,15 @@ See [FEDERATION.md](./FEDERATION.md)
 
 ## Client API
 
-Most methods are similar to Mastodon API, but Mitra is not fully compatible.
+Most methods are similar to Mastodon API, but Fedimovies is not fully compatible.
 
 [OpenAPI spec](./docs/openapi.yaml)
 
 ## CLI
 
-`mitractl` is a command-line tool for performing instance maintenance.
+`fedimoviesctl` is a command-line tool for performing instance maintenance.
 
-[Documentation](./docs/mitractl.md)
+[Documentation](./docs/fedimoviesctl.md)
 
 ## License