Damillora/phoebe
Damillora/phoebe
1
0
Fork 0
mirror of https://github.com/Damillora/phoebe.git synced 2025-03-10 05:57:22 +00:00
Code Issues Projects Releases Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
Damillora 2025-02-23 08:01:10 +00:00
parent a0511415fd
commit 8a5b5c102a
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,12 +1,21 @@
# Shioriko
# shioriko
A booru-like software written in Go and Svelte.
a booru-style image gallery and organizer.
Built with the Go language and Svelte framework, shioriko is designed for personal image gathering.
## Features
* Upload and organize images
* Basic tagging system
* Search and autocomplete based on tags
* Similarity search and duplicate detection using perceptual hash
## Installation
The easiest way to get started is to use Docker:
```bash
docker pull damillora/shioriko
docker run -e POSTGRES_DATABASE=<PostgreSQL DSN> -e AUTH_SECRET=<secret> -e DATA_DIR=/data -e BASE_URL=http://localhost:8080 -p 8080:8080 -v "./data:/data" damillora/shioriko
```
## Requirements
@ -27,4 +36,4 @@ Shioriko is configured using environment variables:
Shioriko is still in an early stage, but contributions are welcome!
## License
[MIT](https://choosealicense.com/licenses/mit/)
shioriko is licensed under the [MIT license](https://choosealicense.com/licenses/mit/).