Add readme

sefcom · Aug 10, 2023 · 6870dc2 · 6870dc2
1 parent 9b9925d
commit 6870dc2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,6 @@
+SEFCOM Cluster Utils
+====================
+
+Currently one utility is included in this package: `sc-utilization``. This
+program will display utilization for the cluster. See `sc-utilization --help`
+for more options.
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,6 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "sefcom_clusterutils"
 description = "Utilities for ASU SEFCOM's kubernetes cluster"
+readme = "README.md"
 requires-python = "~=3.8"
 license = {file = "LICENSE"}
 authors = [{name = "Kevin Phoenix", email = "[email protected]"}]