diff --git a/README.rst b/README.rst index 4b1bbfa..58a9160 100644 --- a/README.rst +++ b/README.rst @@ -12,9 +12,43 @@ Sentiment analysis web services using a common interface: NIF+JSON-LD. With Senpy, you can easily turn your sentiment analysis algorithm into a web service, just by creating a new plugin. +`DEMO on Heroku `_ +Installation +------------ +The stable version can be installed via pip: -`DEMO on Heroku `_ +.. code:: bash + + pip install senpy + + +Alternatively, you can use the development version: + +.. code:: bash + + git clone git@github.com:gsi-upm/senpy + cd senpy + pip install -r requirements.txt + +To install it system-wide, use setuptools: + +.. code:: bash + + python setup.py install + +Using +----- + +You can use the modules included in senpy to build your own application. +However, the easiest and recommended way is to just use the command-line tool to load your plugins and launch the server. + +.. code:: bash + + python -m senpy + +This will create a server with any modules found in the current path. +For more options, see the `--help` page. TO-DO -----