From 8a5b5c102a66157fc8bc4d68c57ed16fc2be4b48 Mon Sep 17 00:00:00 2001 From: Damillora Date: Sun, 23 Feb 2025 08:01:10 +0000 Subject: [PATCH] chore: update readme --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4ecd0a4..188aa5f 100644 --- a/README.md +++ b/README.md @@ -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= -e AUTH_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/) \ No newline at end of file +shioriko is licensed under the [MIT license](https://choosealicense.com/licenses/mit/). \ No newline at end of file