From a1cb029b5ac173b431ecd492398fcc80d82b26c2 Mon Sep 17 00:00:00 2001
From: Ben Schroeter <benjschroeter@gmail.com>
Date: Tue, 15 Oct 2024 16:10:28 +1100
Subject: [PATCH] Updated readme. Fixes #32

---
 .github/wordlist.txt |  2 --
 README.md            | 20 ++++++++++++++++++--
 docs/usage.md        |  8 ++++----
 3 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/.github/wordlist.txt b/.github/wordlist.txt
index 2fb85c8..3482a12 100644
--- a/.github/wordlist.txt
+++ b/.github/wordlist.txt
@@ -1,6 +1,4 @@
-HPCPY
 HPC
-hpcpy
 HPCpy
 pre
 py
diff --git a/README.md b/README.md
index 1ac2fec..2ce63fc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
-# HPCPY
+[![CI pytest](https://github.com/ACCESS-NRI/hpcpy/actions/workflows/ci_pytest.yml/badge.svg?branch=main)](https://github.com/ACCESS-NRI/hpcpy/actions/workflows/ci_pytest.yml)
+[![Documentation Status](https://readthedocs.org/projects/hpcpy/badge/?version=latest)](https://hpcpy.readthedocs.io/en/latest/?badge=latest)
 
-HPCPY is a prototype Python client for interacting with HPC scheduling systems (i.e PBS).
\ No newline at end of file
+# HPCpy
+
+HPCpy is a Python package for interacting with HPC scheduling systems. The package provides generalised clients to communicate with HPC schedulers agnostically.
+
+Currently supported scheduling systems:
+
+- PBS
+- SLURM*
+
+_* under development_
+
+The full documentation is available at [hpcpy.readthedocs.io](https://hpcpy.readthedocs.io)
+
+## License
+
+HPCpy is distributed under the Apache Software License v2.0. Please see the [LICENSE](https://github.com/ACCESS-NRI/hpcpy/blob/main/LICENSE) file in this repository for further details.
\ No newline at end of file
diff --git a/docs/usage.md b/docs/usage.md
index 1dfdd7c..23558a0 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -1,6 +1,6 @@
 # Usage
 
-The following describes the basic usage of hpcpy.
+The following describes the basic usage of HPCpy.
 
 ## Getting a client object
 
@@ -44,7 +44,7 @@ The simplest way to submit a pre-written job script is via the `submit()` comman
 
 ### Environment Variables
 
-=== "HPCPy (Python)"
+=== "HPCpy (Python)"
     ```python
     job_id = client.submit(
         "/path/to/script.sh",
@@ -104,7 +104,7 @@ job_script_filepath = client._render_job_script(
 
 Checking the status of a job that has been submitted requires the `job_id` of the job on on the scheduler. Using the `submit()` command as above will return this identifier for use with the client.
 
-=== "HPCPy (Python)"
+=== "HPCpy (Python)"
     ```python
     status = client.status(job_id)
     ```
@@ -133,7 +133,7 @@ More shorthand methods will be made available as required.
 
 Deleting a job on the system requires only the `job_id` of the job on the scheduler
 
-=== "HPCPy (Python)"
+=== "HPCpy (Python)"
     ```python
     client.delete(job_id)
     ```