Skip to content

Commit

Permalink
Merge pull request #16 from mogproject/topic-refactor-readme
Browse files Browse the repository at this point in the history
refactor README.rst
  • Loading branch information
mogproject committed Jul 12, 2015
2 parents af15698 + 1387a12 commit 59bbce5
Showing 1 changed file with 16 additions and 23 deletions.
39 changes: 16 additions & 23 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ easy-alert

Super Simple Process Monitoring Tool.


.. image:: https://badge.fury.io/py/easy-alert.svg
:target: http://badge.fury.io/py/easy-alert
:alt: PyPI version
Expand All @@ -13,10 +12,11 @@ Super Simple Process Monitoring Tool.
:target: https://travis-ci.org/mogproject/easy-alert
:alt: Build Status

.. image:: https://coveralls.io/repos/mogproject/easy-alert/badge.png?branch=master
:target: https://coveralls.io/r/mogproject/easy-alert?branch=master
.. image:: https://coveralls.io/repos/mogproject/easy-alert/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/mogproject/easy-alert?branch=master
:alt: Coverage Status


.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
:target: http://choosealicense.com/licenses/apache-2.0/
:alt: License
Expand All @@ -43,13 +43,22 @@ Dependencies
Installation
------------

(todo)
* ``pip`` command may need ``sudo``

Just install via pip! (may need ``sudo``)::
+-------------+---------------------------------------+
| Operation | Command |
+=============+=======================================+
| Install |``pip install easy-alert`` |
+-------------+---------------------------------------+
| Upgrade |``pip install --upgrade easy-alert`` |
+-------------+---------------------------------------+
| Uninstall |``pip uninstall easy-alert`` |
+-------------+---------------------------------------+

pip install easy-alert
* Check installed version: ``easy-alert --version``

* Then, write your configuration to the file ``/etc/easy-alert/easy-alert.yml``.

Then, write your configuration to the file ``/etc/easy-alert/easy-alert.yml``.
See an example below.

---------------------
Expand Down Expand Up @@ -88,19 +97,3 @@ Quickstart Guide
easy-alert ssh --check
easy-alert ssh

---------
Upgrading
---------
::

pip install --upgrade easy-alert
easy-alert --version

--------------
Uninstallation
--------------
::

pip uninstall easy-alert

(may need ``sudo``)

0 comments on commit 59bbce5

Please sign in to comment.