Merge pull request #33 from ACCESS-NRI/32-update-readme

Updated readme. Fixes #32

.github/wordlist.txt

@@ -1,6 +1,4 @@
-HPCPY
 HPC
-hpcpy
 HPCpy
 pre
 py

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

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)
     ```