Update README

Signed-off-by: trivernis <trivernis@protonmail.com>
pull/10/head
trivernis 3 years ago
parent 37bc11f4f1
commit 6e5fb7a8bb
Signed by: Trivernis
GPG Key ID: DFFFCC2C7A02DB45

@ -2,34 +2,43 @@
mediarepo
</h1>
<p align="center">
<img src="https://github.com/Trivernis/mediarepo-ui/raw/main/src-tauri/icons/64x64.png"/>
<img src="https://github.com/Trivernis/mediarepo/raw/main/mediarepo-ui/src-tauri/icons/64x64.png"/>
</p>
<h3 align="center" style="color:red">mediarepo is a work in progress</h3>
<p align="center">
<a href="https://github.com/Trivernis/mediarepo/actions/workflows/build.yml">
<img src="https://img.shields.io/github/workflow/status/trivernis/mediarepo/Build%20and%20test?style=for-the-badge">
</a>
<a href="https://mediarepo.trivernis.dev">
<img src="https://img.shields.io/website?style=for-the-badge&url=https%3A%2F%2Fmediarepo.trivernis.dev">
</a>
<a href="https://aur.archlinux.org/packages/mediarepo">
<img src="https://img.shields.io/aur/version/mediarepo?style=for-the-badge">
</a>
<img src="https://img.shields.io/aur/license/mediarepo?style=for-the-badge">
</p>
<h3 align="center" style="color:red">This repository is a work in progress</h3>
- - -
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

Loading…
Cancel
Save