From 7f319b95cbdb087549cb4099c69a4284144dad8e Mon Sep 17 00:00:00 2001 From: Daniel Van Der Maden Date: Sat, 28 Dec 2019 01:35:13 -0800 Subject: [PATCH] [readme] Add basic outline --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56bb046..7b8f1f3 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -PyHmy is a wrapper tool to use Harmony's CLI in python. \ No newline at end of file +# Pyhmy - Harmony's python utilities + +**This library is for python3 only.** + +[Full documentation is located on Harmony's GitBook](https://harmony.one/) (in progress). + +A Python library for interacting and working the [Harmony blockchain](https://harmony.one/) +and [related codebases](https://github.com/harmony-one). + +## Installation +```bash +pip install pyhmy +``` + +## Development +Clone the repository and then run the following to install the dependencies: +```bash +python3 -m pip install requests +python3 -m pip install pexpect +``` +(Optional) Copy over the CLI binary into `/bin/`. Reference +[here](https://app.gitbook.com/@harmony-one/s/home/command-line-interface/using-the-harmony-cli-tool) +for more details on the Harmony CLI. *Note that this library comes with a function (under the `pyhmy.utils`) +to download the statically linked CLI for Linux and MacOS*. + +## Running tests + +TODO testing flow using pytest + +## Releasing + +TODO Automated release flow with proper versioning. \ No newline at end of file