Skip to content

Commit

Permalink
add read the docs refs
Browse files Browse the repository at this point in the history
  • Loading branch information
mike-jt79 committed Jan 28, 2021
1 parent 2f50573 commit 0799021
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# 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

### 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.

Expand Down

0 comments on commit 0799021

Please sign in to comment.