From f38eeac9d07286287bd65269ba9208bad883ffff Mon Sep 17 00:00:00 2001
From: Zachary Spar <zachspar@gmail.com>
Date: Sat, 29 Jun 2024 15:40:56 -0400
Subject: [PATCH] update readme, include table of contents and installation
 docs

---
 .gitignore |  2 ++
 README.md  | 21 +++++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/.gitignore b/.gitignore
index 767ff56..5c2ce9a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -133,3 +133,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+.history/
\ No newline at end of file
diff --git a/README.md b/README.md
index 9eaefe7..f535180 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,27 @@
 # Fred CLI & Python API
 A fully-featured FRED Command-Line Interface & Python API Wrapper.
 
+## Table of Contents
+- [Installation](#installation)
+  - [Homebrew](#homebrew)
+  - [PyPI](#pypi)
+- [Python API Documentation](#python-api-documentation)
+- [Wiki](#wiki)
+- [FRED References](#fred-references)
+- [Shell Auto-Completion](#shell-auto-completion)
+  - [`zsh` Completions](#zsh-completions)
+  - [`bash` Completions](#bash-completions)
+  - [`fish` Completions](#fish-completions)
+
+## Installation:
+Install `fred` in a couple of ways.
+
+### Homebrew
+`brew install fred`
+
+### PyPI
+`pip install fred-py-api`
+
 ## Python API Documentation:
 - [fred-py-api Docs](https://fred-py-api.readthedocs.io/en/latest/)