From 5d44144716342013afe7f493c78984773cb132b5 Mon Sep 17 00:00:00 2001 From: "Jakob L. Kreuze" Date: Fri, 19 Jun 2020 20:37:04 -0400 Subject: Update and clarify README. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0ece336..428f25e 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,18 @@ if you have a use case other than being able to search through your pictures when you are not at home, you would be better off looking at an established solution such as [Danbooru](https://github.com/danbooru/danbooru). +This is a _very_ early release. Perhaps pre-alpha, if there is no stage earlier +in the software release life cycle. Use at your own risk. + +If you are brave enough to give this a try, however, feedback of any sort would +be greatly appreciated. The command-line interface and web UI are designed +around my specific use case, but I would ideally like for this to be usable by +the general public. + ## Features - A command-line tool for interacting with the tag database. +- A web interface for querying and viewing files in the tag database. ## Usage @@ -122,3 +131,13 @@ list of tags for the files, and `image`, the file to be uploaded. ``` POST /api/posts/[filename] ``` + +## TODO + +There are a few things I'd like to push off 'till later, since this is working +for me right now. + +- [birka-cli] Improve the `birka-cli add` interface, allowing multiple files to + be indexed and tagged in the same invocation. +- [birka-web js] Implement a dynamic "endless scroll" view. +- [birka-web js] Implement a mass-tagger tool in the web interface. -- cgit v1.3