Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
--HG--
rename : README.rst => README.md
  • Loading branch information
vlasovskikh committed Feb 10, 2011
1 parent 0f20848 commit e9cfa0e
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 21 deletions.
69 changes: 69 additions & 0 deletions README.md
@@ -0,0 +1,69 @@
convoread
=========

Simple console reader for [Convore][].


Description
-----------

`convoread` supports streaming live messages to the standard output.

Future versions will include posting messages, creating topics, and managing
groups.


Usage
-----

You can watch your live stream indefinitely:

$ python convoread.py
@user1: hello
@user2: convoread works
@user1: @user2 indeed!
^Cinterrupted

Press `Ctrl+C` to exit.

For more info on usage type:

$ python convoread.py --help


Requirements
------------

* Python ≥ 2.6 (Python 3 has some issues yet)


Configuration
-------------

`convoread` uses login and password, supplied in `~/.netrc` file in a standard
format. If you're wondering, what is the format of `.netrc`:

machine convore.com
login <your-username>
password <your-password>


Authors
-------

* [Andrey Vlasovskikh][vlasovskikh]
* [Alexander Solovyov][asolovyov]
* Mikhail Krivushin
* Timofei Perevezentsev


License
-------

MIT License.


[convore]: https://convore.com/
[vlasovskikh]: http://pirx.ru/
[asolovyov]: http://piranha.org.ua/

21 changes: 0 additions & 21 deletions README.rst

This file was deleted.

0 comments on commit e9cfa0e

Please sign in to comment.