From 215da027ea9fa76c4727fdeb2c14db936bfeace9 Mon Sep 17 00:00:00 2001
From: trivernis <trivernis@protonmail.com>
Date: Sat, 23 Oct 2021 21:10:34 +0200
Subject: [PATCH] Add README

Signed-off-by: trivernis <trivernis@protonmail.com>
---
 mediarepo-daemon/Cargo.toml |  2 ++
 mediarepo-daemon/README.md  | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+)
 create mode 100644 mediarepo-daemon/README.md

diff --git a/mediarepo-daemon/Cargo.toml b/mediarepo-daemon/Cargo.toml
index 56bb622..31daa2d 100644
--- a/mediarepo-daemon/Cargo.toml
+++ b/mediarepo-daemon/Cargo.toml
@@ -2,6 +2,8 @@
 name = "mediarepo"
 version = "0.1.0"
 edition = "2018"
+license = "gpl-3"
+repository = "https://github.com/Trivernis/mediarepo-daemon"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
diff --git a/mediarepo-daemon/README.md b/mediarepo-daemon/README.md
new file mode 100644
index 0000000..742b30d
--- /dev/null
+++ b/mediarepo-daemon/README.md
@@ -0,0 +1,34 @@
+<h1 align="center">
+mediarepo
+</h1>
+<h3 align="center" style="color:red">This repository is a work in progress</h3>
+
+- - -
+
+This repository contains a media repository daemon that allows one to manage their media (mainly images).
+It works similar to image boards (boorus) as it allows one to assign tags to media entries and
+search for entries by using those tags. It is heavily inspired by [hydrus](https://github.com/hydrusnetwork/hydrus/).
+
+## Usage
+
+1. Initialize an empty repository
+```
+mediarepo --repo "where/your/repo/should/be" init
+```
+
+2. Import some images
+```
+mediarepo --repo "path/to/your/repo" import "path/to/your/files/as/**/glob/*.png"
+``` 
+
+3. Start the daemon
+```
+mediarepo --repo "path/to/your/repo start
+```
+
+4. Open the mediarepo-ui and connect to the repository
+
+
+## License
+
+GPL-3
\ No newline at end of file