From 6e5fb7a8bbde8c20587e8c34031da9efc7b1beb8 Mon Sep 17 00:00:00 2001 From: trivernis Date: Wed, 2 Feb 2022 20:51:05 +0100 Subject: [PATCH] Update README Signed-off-by: trivernis --- README.md | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4188192..0e922fd 100644 --- a/README.md +++ b/README.md @@ -2,34 +2,43 @@ mediarepo

- + +

+

mediarepo is a work in progress

+

+ + + + + + + + + +

-

This repository is a work in progress

- - - Mediarepo is a tool for managing media files. 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/). +search for entries by using those tags. It is inspired by [hydrus](https://github.com/hydrusnetwork/hydrus/) with the goal to provide a good looking and fast +way to organize all kinds of media. -## Usage +## Installation -1. Initialize an empty repository -``` -mediarepo --repo "where/your/repo/should/be" init -``` +In order to use mediarepo, the mediarepo daemon and UI application need to be installed. +Both can be downloaded from the [Releases](https://github.com/Trivernis/mediarepo/releases) page or the AUR. -2. Import some images +```sh +yay -S mediarepo-daemon mediarepo ``` -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 -``` +When installing manually the `mediarepo-daemon` binary needs to be accessible in the `PATH` variable. + +## Usage and Further Information -4. Open the mediarepo-ui and connect to the repository +Please consult the [official website](https://mediarepo.trivernis.dev) for more information. ## License