summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob L. Kreuze <zerodaysfordays@sdf.org>2020-07-26 19:23:37 -0400
committerJakob L. Kreuze <zerodaysfordays@sdf.org>2020-07-26 19:23:37 -0400
commitb311644824bc0bff9603fea69d979fa6bb4b97e0 (patch)
tree221b0b6a5f1a90f953ecf03445fe6aed17ffee6b /README.md
parent45b48fd9b9ee21759701d3d4f445d8bf141d3f9e (diff)
Rebrand (again).
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 20 insertions, 22 deletions
diff --git a/README.md b/README.md
index 9d24c59..f756061 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,11 @@
-# бирка-тян: электронная доска объявлений
+# Kona: An Imageboard Engine
-_В вашем деле нет пометки об этом!_
-
-бирка-тян (birka-tyan) is a lightweight Danbooru-style imageboard engine for the
-purposes of self-hosting a tagged image gallery. It lacks many of the features
-one would expect of such an application (particularly use rauthentication), so
-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).
+Kona is a lightweight Danbooru-style imageboard engine for the purposes of
+self-hosting a tagged image gallery. It lacks many of the features one would
+expect of such an application (particularly use rauthentication), so 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.
@@ -26,7 +24,7 @@ the general public.
### Command-Line
-There are two ways of interacting with бирка-тян: through the `birka-cli`
+There are two ways of interacting with бирка-тян: through the `kona-cli`
command-line tool (i), and through the web interface (ii).
The inclusion of (i) is in consideration for this being, essentially, a personal
@@ -40,26 +38,26 @@ or more tags following the path of an image. The path is automatically
canonicalized, so relative names are perfectly acceptable.
```sh
-$ birka-cli add Cat.jpeg animal cat cute
+$ kona-cli add Cat.jpeg animal cat cute
```
Ah, drat. We should have tagged that image with "photograph", too.
```sh
-$ birka-cli add_tags Cat.jpeg photograph
+$ kona-cli add_tags Cat.jpeg photograph
```
On second thought, that wasn't a particularly cute picture.
```sh
-$ birka-cli remove_tags Cat.jpeg cute
+$ kona-cli remove_tags Cat.jpeg cute
```
Now, let's see all of the photographs in the tag database tagged with
"photograph".
```sh
-$ birka-cli query photograph
+$ kona-cli query photograph
/home/jakob/Camera/Cat.jpeg
```
@@ -70,29 +68,29 @@ convenience, the 'query' command can be invoked without a query string, to list
all paths indexed by the database.
```sh
-$ birka-cli query
+$ kona-cli query
...
```
The tag database is stored in a file, and the path of that file is dependent on
how the program is invoked. If, when parsing the command-line arguments,
-`birka-cli` sees a `-o` or `--output` argument, the path following that argument
+`kona-cli` sees a `-o` or `--output` argument, the path following that argument
will be used. Alternatively, the `TB_PATH` environment variable can be
specified, but `-o` takes a higher precedence. If neither are specified,
-"birka.db" in the current directory is used.
+"kona.db" in the current directory is used.
A few other things that can be done from the command-line:
Removing an image can be done with 'remove'.
```sh
-$ birka-cli remove Cat.jpeg
+$ kona-cli remove Cat.jpeg
```
Getting the tags in the database:
```sh
-$ birka-cli tags
+$ kona-cli tags
...
```
@@ -152,7 +150,7 @@ POST /api/posts/[filename]
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
+- [kona-cli] Improve the `kona-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.
+- [kona-web js] Implement a dynamic "endless scroll" view.
+- [kona-web js] Implement a mass-tagger tool in the web interface.