README.rst

changeset 7
415d034b0864
parent 2
c492770144c4
child 8
cf12f8c7838e
--- a/README.rst	Fri Nov 24 18:50:29 2017 +0200
+++ b/README.rst	Tue Dec 12 09:20:49 2017 +0200
@@ -1,8 +1,8 @@
-SCC access script
+Overview
 =================
 
-This small scripts permits interacting with the Single Calculus Chain through
-the command line. Specifically, with the script you can:
+This package provides a script which permits interacting with the
+Single Calculus Chain through the command line. Specifically, with the script you can:
 
 * Upload a file to the SCC for processing
 * Download the processed files and graphs
@@ -24,15 +24,14 @@
 Installation
 ------------
 
-The only requirement for running this program is the requests python module.
-If you have pip installed you can install it by::
+The easiest way to install this module is from the python package index using pip:
 
-   pip install requests.
+   pip install scc_access
 
 See http://docs.python-requests.org/en/latest/user/install/ for more details.
 
-You can use the script by cloning this mercurial repository. Alternatively, you 
-can just coppy the scc_access.py and and settings.sample.py files to a local 
+You can also use the script by cloning this mercurial repository. Alternatively, you 
+can just copy the scc_access.py and and settings.sample.py files to a local 
 directory.
 
 

mercurial