Update README, rename to test

PythonCoderAS · PythonCoderAS · commit e7be91fbbdfd · 2022-06-12T16:47:10.000-04:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,7 +8,7 @@ on:
     branches: [master]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
 
     strategy:
diff --git a/README.md b/README.md
@@ -1,3 +1,19 @@
 # github-run-script
 
 Run a script on multiple repositories, cloning them if needed.
+
+```
+  Description
+    Run a script on multiple repositories, cloning them if needed.
+
+  Usage
+    $ github-run-script <script> [options]
+
+  Options
+    -o, --owner          The owner for repositories without an explicit owner.
+    -s, --search-path    A path to search for already-cloned repositories.
+    -t, --terminate      Terminate any spawned processes on error.
+    -s, --signal         The signal to terminate a process with.
+    -v, --version        Displays current version
+    -h, --help           Displays this message
+```
