You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mediarepo/README.md

46 lines
1.7 KiB
Markdown

<h1 align="center">
mediarepo
</h1>
<p align="center">
<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>
- - -
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 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.
## Installation
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.
```sh
yay -S mediarepo-daemon mediarepo
```
When installing manually the `mediarepo-daemon` binary needs to be accessible in the `PATH` variable.
## Usage and Further Information
Please consult the [official website](https://mediarepo.trivernis.dev) for more information.
## License
GPL-3