From 80146218bef2afb5dd9e3b20f33c26b4b79a2308 Mon Sep 17 00:00:00 2001
From: thomas loubrieu <thomas.loubrieu@jpl.nasa.gov>
Date: Thu, 24 Sep 2020 17:29:27 -0700
Subject: [PATCH] README clean up

---
 README.md | 78 +++++++++++++++++++------------------------------------
 1 file changed, 27 insertions(+), 51 deletions(-)

diff --git a/README.md b/README.md
index 898f753a..b1fc230a 100644
--- a/README.md
+++ b/README.md
@@ -3,40 +3,14 @@
 This tools provides services for PDS operators to mint DOIs.
 
 
-
-
 ## Prerequisites
 
 - python 3
 - a login to OSTI server
 
-## Usage 
-
-    pds-doi-cmd --help
-
-    pds-doi-cmd draft -c 'Cartography and Imaging Sciences Discipline' -i 'https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/bundle.xml'
-    pds-doi-cmd draft -c 'Cartography and Imaging Sciences Discipline' -i input/bundle_in_with_contributors.xml 
-    pds-doi-cmd draft -c 'Cartography and Imaging Sciences Discipline' -i 'https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/data/collection_data.xml'
-
-    pds-doi-cmd reserve -c 'Cartography and Imaging Sciences Discipline' -i input/DOI_Reserved_GEO_200318.xlsx
-    pds-doi-cmd reserve -c 'Cartography and Imaging Sciences Discipline' -i input/DOI_Reserved_GEO_200318.csv
-    pds-doi-cmd reserve -c 'Cartography and Imaging Sciences Discipline' -i input/OSTI_IAD_submitted_records_Reserved-only_20200304.csv 
+## User Documentation 
 
-### Supported inputs
-
-#### PDS4 Label
-
-- Bundle - https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/bundle.xml
-- Data Collection - https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/data/collection_data.xml
-- Browse Collection - https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/browse/collection_browse.xml
-- Calibration Collection - https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/calibration/collection_calibration.xml
-- Document Collection - https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/document/collection_document.xml
-
-#### tables
-For reserved dois, `xlsx` and `csv` inputs are supported.
-
-#### osti format
-The osti format can be used as an input for release.
+    https://nasa-pds.github.io/pds-doi-service/ 
 
 ## Developers
 
@@ -55,14 +29,14 @@ Install virtual env
 
 Deploy dependancies:
 
-    pip install -r requirements.txt
+    pip install -r requirements_dev.txt
     
 or
     
     pip intall -e .
     
     
-## Launch server
+## Launch api server (to be re-worked)
 
     pds-doi-start-dev
     
@@ -73,42 +47,44 @@ or
 
     python setup.py test
 
-The service, in a browser http://127.0.0.1:5000/create_osti_label?target_url=%22https://pds-imaging.jpl.nasa.gov/data/nsyt/insight_cameras/bundle.xml%22&contributor=%22Cartography+and+Imaging+Sciences+Discipline%22
+### Behavioral testing
 
-### Behaviroal testing
+You first need to get some reference datasets, in the project base directory:
 
-    behave
-    
+    curl https://pds.nasa.gov/software/test-data/pds-doi-service/aaDOI_production_submitted_labels.zip > aaDOI_production_submitted_labels.zip
+    unzip aaDOI_production_submitted_labels.zip
 
+Then you can run the behavioral tests:
 
+    behave
 
-## Build
+You can also run them for a nicer reporting:
 
-### Development build 
+    behave -f allure_behave.formatter:AllureFormatter -o ./allure ./features 
+    allure service allure
+    
+## Documentation management
 
-A development build is publish for every push on the "dev" branch
+### Design :
 
-It is available in the release section of gitHub
+See in this repository:
 
-### Release
+https://github.com/NASA-PDS/pds-doi-service/tree/master/docs
 
-To be completed
+### User documentation
 
+Managed with sphynx
 
-## Deploy    
+    brew install sphinx-doc
+    pip install -r requirements_dev.txt
+    cd docs
+    sphinx-build -b html source build -a 
 
-Deploy the package and launch the API server (for demo or test purpose):
 
-    pip install  --upgrade --force-reinstall https://github.com/NASA-PDS-Incubator/pds-doi-service/releases/download/0.0.1%2Bdev/pds_doi_core-0.0.1+dev-py3-none-any.whl
-    pds-doi-start-dev
-    
-## Generate documentation
+      
+## Build & Release
 
-    brew install sphinx-doc
-    pip install -r requirements.txt
-    cd docs
-    sphinx-build -b html source build -a
-    
+The build and release process is managed in github actions.