Skip to content
This repository has been archived by the owner on Jan 13, 2019. It is now read-only.

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jjangsangy committed Dec 8, 2014
1 parent f0ec98c commit d46c572
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
============
py-translate
============

Expand All @@ -8,7 +9,6 @@ A simple translation command line utility
.. figure:: https://raw.githubusercontent.com/jjangsangy/py-translate/master/img/alice.gif
:alt: Translate Lewis Carroll: Alice in Wonderland

Translate Lewis Carroll: Alice in Wonderland
The end goal is a simple application for translating text in the
terminal. Text can be generated interactively or programmatically in the
shell environment. Through command line arguments, file descriptors or
Expand All @@ -31,7 +31,7 @@ Installation
From PyPI with pip (easy)
~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: sh
.. code-block:: sh
$ pip install py-translate
Expand All @@ -40,13 +40,13 @@ From Source at Github

- Clone the repository

.. code:: sh
.. code-block:: sh
$ git clone https://github.com/jjangsangy/py-translate.git
- Install with setup.py

.. code:: sh
.. code-block:: sh
$ python setup.py install
Expand Down Expand Up @@ -82,20 +82,18 @@ Examples

- Default will translate from english to target language

.. code:: sh
.. code-block:: sh
$ translate zh-TW <<< 'Hello World!'
你好世界!
.. figure:: https://raw.githubusercontent.com/jjangsangy/py-translate/master/img/helloworld.gif
:alt: Hello World

Hello World

- Just as easily specify a source language by providing it as first
argument

.. code:: sh
.. code-block:: sh
# Translate Hello from French to English
$ translate fr en <<< 'Bonjour, comment allez-vous!'
Expand All @@ -104,7 +102,7 @@ Examples
Redirect from File
~~~~~~~~~~~~~~~~~~

.. code:: sh
.. code-block:: sh
$ translate zh-TW < 'alice.txt'
Expand All @@ -121,7 +119,7 @@ Redirect from File
Chaining together Pipes
~~~~~~~~~~~~~~~~~~~~~~~

.. code:: sh
.. code-block:: sh
# Multiple Chaining
$ echo 'What is love?' | translate zh-TW | translate zh-TW ko | translate ko fr | translate fr en
Expand All @@ -130,7 +128,7 @@ Chaining together Pipes
Be Creative!
~~~~~~~~~~~~

.. code:: sh
.. code-block:: sh
# Grocery List
$ cat << BUY | translate ko
Expand All @@ -154,9 +152,12 @@ Find the latest documentation http://pythonhosted.org//py-translate/
.. |Documentation Status| image:: https://readthedocs.org/projects/py-translate/badge/?version=master
:target: https://readthedocs.org/projects/py-translate/?badge=master
.. |github| image:: https://badge.fury.io/gh/jjangsangy%2Fpy-translate.svg
:target: http://badge.fury.io/gh/jjangsangy%2Fpy-translate
.. |travis| image:: https://travis-ci.org/jjangsangy/py-translate.svg?branch=master
:target: https://travis-ci.org/jjangsangy/py-translate
.. |pypi| image:: https://badge.fury.io/py/py-translate.svg
:target: http://badge.fury.io/py/py-translate

0 comments on commit d46c572

Please sign in to comment.