Skip to content
This repository has been archived by the owner on Dec 24, 2022. It is now read-only.

Commit

Permalink
Update README with list of exported functions
Browse files Browse the repository at this point in the history
  • Loading branch information
aw committed Nov 28, 2019
1 parent 29be353 commit 664de67
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Expand Up @@ -5,9 +5,10 @@
1. [Requirements](#requirements)
2. [Installation](#installation)
3. [Environment](#environment)
4. [Usage](#usage)
5. [Testing](#testing)
6. [License](#license)
4. [Functions](#functions)
5. [Usage](#usage)
6. [Testing](#testing)
7. [License](#license)

# Requirements

Expand Down Expand Up @@ -47,6 +48,20 @@ To manage the _Admin API_ instead of the _Meta API_:

To obtain an _On-Prem Meta_ OVA, please visit [https://on-premises.com](https://on-premises.com)

# Functions

The following functions are exported:

* `makeSHA256()` to generate an SHA256 string
* `makeHMAC()` to generate an SHA256 HMAC from a string and key
* `buildRequest()` to generate a request object to be sent to the `apiCall()` function
* `apiCall()` to send the actual request object to the Meta API
* `buildOVA()` to build an OVA through the Meta API
* `getStatus()` to obtain the status of an OVA build
* `pollStatus()` to poll the status of an OVA build (every 5 seconds)

See the usage docs below.

# Usage

1. [CoffeeScript](#coffeescript)
Expand Down

0 comments on commit 664de67

Please sign in to comment.