1
0
mirror of https://github.com/ihabunek/toot.git synced 2024-11-03 04:17:21 -05:00
toot/README.rst
2021-05-24 15:43:52 +02:00

53 lines
1.9 KiB
ReStructuredText

============================
Toot - a Mastodon CLI client
============================
.. image:: https://raw.githubusercontent.com/ihabunek/toot/master/trumpet.png
Toot is a CLI and TUI tool for interacting with Mastodon instances from the command line.
.. image:: https://img.shields.io/travis/ihabunek/toot.svg?maxAge=3600&style=flat-square
:target: https://travis-ci.org/ihabunek/toot
.. 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
---------
* Homepage: https://github.com/ihabunek/toot
* Issues: https://github.com/ihabunek/toot/issues
* Documentation: https://toot.readthedocs.io/en/latest/
* 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/>`_
Features
--------
* Posting, replying, deleting statuses
* 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
Terminal User Interface
-----------------------
toot includes a terminal user interface (TUI). Run it with ``toot tui``.
.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/tui_list.png
.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/tui_compose.png
License
-------
Copyright Ivan Habunek <ivan@habunek.com> and contributors.
Licensed under `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_, see `LICENSE <LICENSE>`_.