From 369d26bf0428fb271969aa7f06b685e3ba335e05 Mon Sep 17 00:00:00 2001
From: Katherine Eaton <ktmeaton@gmail.com>
Date: Thu, 18 Feb 2021 13:00:46 -0500
Subject: [PATCH] installation docs

---
 README.md | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 59df1a7..939c989 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,17 @@
 # autologs
-Automatically create release notes and changelog.
 
+Automatically document commit history, release notes, and a changelog.
 
-Parameters
+## Install
 
-1. Old version (tag or commit hash)
-1. New version (tag or commit hash)
-1. Max commits to print
-1. Notes directory
+Add as a submodule to an existing git repository.
+
+```bash
+git submodule add https://github.com/ktmeaton/autologs
+./autologs/autologs --help
+```
 
 ## Credits
 
-Argument Parsing: <https://medium.com/@Drew_Stokes/bash-argument-parsing-54f3b81a6a8f>
-Help: <https://opensource.com/article/19/12/help-bash-program>
+Argument Parsing: <https://medium.com/@Drew_Stokes/bash-argument-parsing-54f3b81a6a8f>  
+Help Function: <https://opensource.com/article/19/12/help-bash-program>