From 071c24535fa7377a6965aff35b8c0f6f1285a85d Mon Sep 17 00:00:00 2001
From: Alan Orth <alan.orth@gmail.com>
Date: Wed, 3 Oct 2018 11:12:18 +0300
Subject: [PATCH] README.md: Add TODO about API versions

---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9c16849..54947ba 100644
--- a/README.md
+++ b/README.md
@@ -7,12 +7,17 @@ A simple REST API to expose Solr view and download statistics for items in a DSp
 - PostgreSQL version 9.5+ (due to [`UPSERT` support](https://wiki.postgresql.org/wiki/UPSERT))
 - DSpace 4+ with [Solr usage statistics enabled](https://wiki.duraspace.org/display/DSDOC5x/SOLR+Statistics)
 
-## Installation
-Create a virtual environment and run it:
+## Installation and Testing
+Create a Python virtual environment and install the dependencies:
 
     $ python -m venv venv
     $ . venv/bin/activate
     $ pip install -r requirements.txt
+
+Set up the environment variables Solr and PostgreSQL:
+
+    $ export SOLR_SERVER=http://localhost:8080/solr
+    $ 
     $ gunicorn app:api
 
 ## Deployment
@@ -33,6 +38,7 @@ The API exposes the following endpoints:
 - Better logging
 - Tests
 - Check if database exists (try/except)
+- Version API
 
 ## License
 This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).