Skip to content

Commit

Permalink
Updated sample image for github page
Browse files Browse the repository at this point in the history
  • Loading branch information
danschwarz committed Mar 11, 2024
1 parent 538d0e3 commit c624809
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 16 deletions.
38 changes: 22 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,22 @@
============================
Toot - a Mastodon CLI client
Toot - a Mastodon CLI client - *toot-img fork*
============================
----------------------------
This fork has image support, notification alerts, and more...
----------------------------

.. image:: https://raw.githubusercontent.com/ihabunek/toot/master/trumpet.png
.. image:: https://raw.githubusercontent.com/danschwarz/toot/tootimg/trumpet.png

Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.

.. image:: https://img.shields.io/badge/author-%40ihabunek-blue.svg?maxAge=3600&style=flat-square
:target: https://mastodon.social/@ihabunek
.. image:: https://img.shields.io/github/license/ihabunek/toot.svg?maxAge=3600&style=flat-square
:target: https://opensource.org/licenses/GPL-3.0
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
:target: https://pypi.python.org/pypi/toot

Resources
Resources for this fork
---------

* Homepage: https://github.com/ihabunek/toot
* Issues: https://github.com/ihabunek/toot/issues
* Documentation: https://toot.bezdomni.net/
* Mailing list for discussion, support and patches:
https://lists.sr.ht/~ihabunek/toot-discuss
* Informal discussion: #toot IRC channel on `libera.chat <https://libera.chat/>`_
* Homepage: https://github.com/danschwarz/tootimg
* Issues: https://github.com/danschwarz/tootimg/issues

Features
--------
Expand All @@ -30,16 +25,27 @@ Features
* Support for media uploads, spoiler text, sensitive content
* Search by account or hash tag
* Following, muting and blocking accounts
* Simple switching between authenticated in Mastodon accounts
* Simple switching between multiple Mastodon accounts

Terminal User Interface
-----------------------

toot includes a terminal user interface (TUI). Run it with ``toot tui``.

.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_list.png
Features Exclusive to this Fork
----------------------

.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/images/tui_compose.png
* Image display in any modern terminal that supports truecolor
* High resolution images in Kitty, iTerm2, and compatible terminal emulators like WezTerm
* Notification Alert Indicator
* Focus Indicator
* Readline-style editing controls in the Compose window

.. image :: https://raw.githubusercontent.com/danschwarz/toot/tootimg/docs/images/tui_list.png
Toot supports display of high resolution images in `Kitty <https://sw.kovidgoyal.net/kitty/>`_, `iTerm2 <https://iterm2.com/>`_, and a few other terminal emulators. Run it with ``toot tui -f kitty`` or ``toot tui -f iterm``.

.. image :: https://raw.githubusercontent.com/danschwarz/toot/tootimg/docs/images/hires-status.png
License
Expand Down
Binary file added docs/images/hires-status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/tui_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c624809

Please sign in to comment.