witchie/README.rst

47 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2017-05-08 07:17:32 +00:00
============================
Toot - a Mastodon CLI client
============================
2017-04-12 15:23:50 +00:00
.. image:: https://raw.githubusercontent.com/ihabunek/toot/master/trumpet.png
Interact with Mastodon social network from the command line.
2017-04-12 15:23:50 +00:00
2017-04-16 13:07:27 +00:00
.. image:: https://img.shields.io/travis/ihabunek/toot.svg?maxAge=3600&style=flat-square
:target: https://travis-ci.org/ihabunek/toot
2017-04-12 15:23:50 +00:00
.. image:: https://img.shields.io/badge/author-%40ihabunek-blue.svg?maxAge=3600&style=flat-square
:target: https://mastodon.social/@ihabunek
2017-08-26 09:35:20 +00:00
.. image:: https://img.shields.io/github/license/ihabunek/toot.svg?maxAge=3600&style=flat-square
2017-04-12 15:23:50 +00:00
:target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/pypi/v/toot.svg?maxAge=3600&style=flat-square
:target: https://pypi.python.org/pypi/toot
2017-04-12 14:42:04 +00:00
Documentation
-------------
2017-04-12 14:42:04 +00:00
Documentation is hosted on readthedocs.io. Check it out for instruction on installation, usage and more.
2018-06-12 10:14:18 +00:00
https://toot.readthedocs.io/en/latest/
2018-06-12 10:14:18 +00:00
Features
--------
2018-06-12 10:14:18 +00:00
* Posting, replying, deleting statuses
* Support for media uploads, spoiler text, sensitive content
* Search by account or hash tag
* Following, muting and blocking accounts
2018-08-20 22:42:46 +00:00
* Simple switching between authenticated in Mastodon accounts
2018-06-12 10:14:18 +00:00
Curses UI
---------
2018-06-12 10:14:18 +00:00
toot has an experimental curses based console UI.
2018-06-12 10:14:18 +00:00
.. image :: https://raw.githubusercontent.com/ihabunek/toot/master/docs/_static/curses.png
2017-05-08 07:17:32 +00:00
License
-------
Copyright 2018 Ivan Habunek <ivan@habunek.com>
2017-05-08 07:17:32 +00:00
Licensed under `GPLv3 <http://www.gnu.org/licenses/gpl-3.0.html>`_, see `LICENSE <LICENSE>`_.