update readme, include table of contents and installation docs

zachspar · Jun 29, 2024 · f38eeac · f38eeac
1 parent 1fd7963
commit f38eeac
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -133,3 +133,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+.history/
diff --git 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/)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -133,3 +133,5 @@ dmypy.json

		# Pyre type checker
		.pyre/

		.history/