update usage docs

ktmeaton · Feb 18, 2021 · 8bc9b1b · 8bc9b1b
1 parent abe0fe2
commit 8bc9b1b
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -1,22 +1,23 @@
 # autologs
 
-[![GitHub release](https://img.shields.io/github/release/ktmeaton/autologs)](https://github.com/ktmeaton/autologs/releases/)
+[![GitHub release](https://img.shields.io/github/release/ktmeaton/autologs/all.svg)](https://GitHub.com/ktmeaton/autologs/releases/)
 [![Test](https://github.com/ktmeaton/autologs/actions/workflows/test.yaml/badge.svg)](https://github.com/ktmeaton/autologs/actions/workflows/test.yaml)
 [![Lint](https://github.com/ktmeaton/autologs/actions/workflows/lint.yaml/badge.svg)](https://github.com/ktmeaton/autologs/actions/workflows/lint.yaml)
 
-Automatically create commit history, release notes, and a changelog.
+Automatically create release notes and a changelog.
 
 ## Install
 
 ### Executable
 
 ```bash
 # Download executable
-curl https://raw.githubusercontent.com/ktmeaton/autologs/main/autologs -o autologs
+curl https://raw.githubusercontent.com/ktmeaton/autologs/v0.1.0/autologs -o autologs
 
 # Add to path
 sudo mv autologs /usr/local/bin/
 
+# Test installation
 autologs --help
 ```
 
@@ -57,9 +58,9 @@ $ autologs --commits --max-commits 3
 ### Release Notes
 
 ``` bash
-$ autologs --release --max-commits 5
+$ autologs --release --new-tag v0.1.0 --max-commits 3
 
-## Development
+## v0.1.0
 
 ### Notes
 
@@ -78,44 +79,43 @@ $ autologs --release --max-commits 5
 
 ### Commits
 
-* [```365e6aa```](https://github.com/ktmeaton/autologs/commit/365e6aa) test markdown code rendering
-* [```a945418```](https://github.com/ktmeaton/autologs/commit/a945418) Merge pull request #2 from ktmeaton/dev
-* [```de3dd7f```](https://github.com/ktmeaton/autologs/commit/de3dd7f) start documenting commit usage
+* [```abe0fe2```](https://github.com/ktmeaton/autologs/commit/abe0fe2) rename notes and fix pr title
+* [```c033197```](https://github.com/ktmeaton/autologs/commit/c033197) move new tag naming into release
+* [```ce2fded```](https://github.com/ktmeaton/autologs/commit/ce2fded) fix pr dependency on max commits
 ```
 
 ### Changelog
 
 ```bash
-$ autologs --changelog --max-commits 3
-
-# CHANGELOG
-
-## Development
-
-### Notes
-
-1. Create repository.
-1. Add scripts.
-1. Add release workflow.
-1. Remove hard-coded variables.
-1. Simplify script naming.
-1. Create the autologs main executable.
-1. Make autologs a standalone executable.
+autologs --changelog
+```
 
-### Pull Requests
+See [CHANGELOG.md](https://github.com/ktmeaton/autologs/blob/v0.1.0/CHANGELOG.md) for output.
 
-* [```pull/2```](https://github.com/ktmeaton/autologs/pull/2) Prelim Commit Documentation
-* [```pull/1```](https://github.com/ktmeaton/autologs/pull/1) Installation Docs
+## Help
 
-### Commits
+```bash
+$ autologs --help
+Automatically create commit history, release notes, and a changelog.
 
-* [```efe7f5b```](https://github.com/ktmeaton/autologs/commit/efe7f5b) make autologs executable
-* [```e47ae92```](https://github.com/ktmeaton/autologs/commit/e47ae92) fix uses typo
-* [```3197dc0```](https://github.com/ktmeaton/autologs/commit/3197dc0) test 'test' workflow
+Syntax: autologs [-h|-v|-o|--old-tag|--new-tag|--max-commits|--notes-dir|--commits|--release]
+
+Options:
+        -h, --help        Print this Help.
+        -v, --version     Print software version and exit.
+        -o, --output      Output file.                                [ default: /dev/stdout ]
+        --old-tag         An earlier tag/commit hash to compare to.   [ default: a4c28c5 ]
+        --new-tag         A newer tag/commit hash to compare to.      [ default: HEAD ]
+        --max-commits     The maximum number of commits to print.     [ default: 20 ]
+        --notes-dir       A directory containing manual notees.       [ default: docs/notes ]
+        --commits         Print commit history.
+        --release         Print release notes.
+        --changelog       Print changelog.
 ```
 
 ## Credits
 
+Author: [Katherine Eaton](https://ktmeaton.github.io/)  
 Commit History Style: <https://github.com/yuzu-emu/yuzu-mainline/releases>  
 Argument Parsing: <https://medium.com/@Drew_Stokes/bash-argument-parsing-54f3b81a6a8f>  
 Help Function: <https://opensource.com/article/19/12/help-bash-program>
diff --git a/autologs b/autologs
@@ -50,7 +50,7 @@ Help()
   # Display Help
   # Credits: https://opensource.com/article/19/12/help-bash-program
   # Display Help
-  echo "Automatically create commit history, release notes, and a changelog."
+  echo "Automatically create release notes and a changelog."
   echo
   echo "Syntax: autologs [-h|-v|-o|--old-tag|--new-tag|--max-commits|--notes-dir|--commits|--release]"
   echo

diff --git a/docs/notes/Notes_Development.md b/docs/notes/Notes_Development.md
@@ -0,0 +1,3 @@
+# Development
+
+1. Begin next version.