From 07990214b342c2763ce3361f38fa955cb3013639 Mon Sep 17 00:00:00 2001 From: Mike Turner Date: Thu, 28 Jan 2021 16:20:46 +0000 Subject: [PATCH] add read the docs refs --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34e3451..13eef9d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Epic by Zenotech - Command Line Interface -[![PyPI version](https://badge.fury.io/py/epiccli.svg)](https://badge.fury.io/py/epiccli) +[![Documentation Status](https://readthedocs.org/projects/epic-cli/badge/?version=latest)](http://epic-cli.readthedocs.io/?badge=latest) [![PyPI version](https://badge.fury.io/py/epiccli.svg)](https://badge.fury.io/py/epiccli) + + [EPIC](epic.zenotech.com) is a cloud platform for interfacing with HPC resources. This Python CLI demonstrates the `pyepic` module, which interfaces with the EPIC REST API. ## Installation @@ -7,6 +9,9 @@ ### From PyPi You can install the package from PyPi using pip with `pip install epiccli` +### Documentation +Documentation is available on [read the docs](http://epic-cli.readthedocs.io/?badge=latest). + ## Usage To get started run `epic configure` and enter your EPIC configuration details. This will generate the configuration file for the program.