docs: add cap-cli description

Signed-off-by: Ana Trisovic <ana.trisovic@gmail.com>
atrisovic · Jun 15, 2018 · 1d91d31 · 1d91d31
1 parent 2f0f8a0
commit 1d91d31
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,3 @@
-# CAP Client
-This repository provides the CAP command-line client that researchers could use to talk to some CAP server in order to preserve and manage their analyses.
+# CERN Analysis Preservation: CAP-Client
+
+CAP-client is the Python client library for the [CERN Analysis Preservation (CAP)](https://analysispreservation.cern.ch) API. It is a command-line tool that facilitates preservation of physics data analyses, by allowing analysts to capture and store their analysis resources. The CAP-client is a free and open source project developed at [CERN](https://home.cern).
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,10 @@
-.. cap-client documentation master file, created by
-sphinx-quickstart on Fri Aug 25 14:52:59 2017.
-You can adapt this file completely to your liking, but it should at least
-contain the root `toctree` directive.
-
 Welcome to cap-client's documentation!
 ======================================
 
+CAP-client is the Python client library for the `CERN Analysis Preservation (CAP) <https://analysispreservation.cern.ch>`_ API. It is a command-line tool that facilitates preservation of physics data analyses, by allowing analysts to capture and store their analysis resources. The CAP-client is a free and open source project developed at `CERN <https://home.cern>`_.
+
+For more information about CAP, please proceed to the `full documentation <https://cernanalysispreservation.readthedocs.io/en/latest/index.html>`_.
+
 Installation
 ======