From e16999e830f93a49281983a530f58b58d2cf413b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ng=C3=B4=20Ng=E1=BB=8Dc=20=C4=90=E1=BB=A9c=20Huy?= Date: Thu, 8 Feb 2024 11:20:45 +0700 Subject: [PATCH] Convert to markdown for sourcehut --- README.rst => README.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) rename README.rst => README.md (65%) diff --git a/README.rst b/README.md similarity index 65% rename from README.rst rename to README.md index 7ca10ba..d0ffcd0 100644 --- a/README.rst +++ b/README.md @@ -1,20 +1,16 @@ -============================ -Witchie - an Akkoma CLI client -============================ +# Witchie - an Akkoma CLI client Witchie is a CLI and TUI tool for interacting with Akkoma instances from the command line. It is a fork of [ibuhanek's toot](https://github.com/ihabunek/toot) for Mastodon to add Akkoma-specific features, such as custom emoji reacts or quote. -Resources ---------- +## Resources * Homepage: https://sr.ht/~huyngo/witchie * Mailing list for discussion: https://lists.sr.ht/~huyngo/witchie * Bugs/feature requests: https://todo.sr.ht/~huyngo/witchie -Features --------- +## Features * Posting, replying, deleting statuses * Support for media uploads, spoiler text, sensitive content @@ -22,18 +18,16 @@ Features * Following, muting and blocking accounts * Simple switching between authenticated accounts -Terminal User Interface ------------------------ +## Terminal User Interface -witchie includes a terminal user interface (TUI). Run it with ``witchie tui``. +witchie includes a terminal user interface (TUI). Run it with `witchie tui`. -.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_list.png +![TUI timeline](https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_list.png) -.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_compose.png +![compose post in TUI](https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_compose.png) -License -------- +## License Copyright 2017-2023 Ivan Habunek and contributors. Copyright 2023 Ngô Ngọc Đức Huy