Skip to content

Commit fbdb723

Browse files
committed
added TOC to readme
1 parent 79fc207 commit fbdb723

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,28 @@
44

55
The device monitors a list of your websites and lets you know if any of them are down. Still working on the logic but all green means all good. Red means 3+ sites are down, and yellow means 1-2 are down. More than one light can be on at once for now while I'm still figuring out the logic I want to implement.
66

7+
## Table of Contents
8+
9+
1. [Getting Started](#getting-started)
10+
1. [Hardware](#hardware)
11+
2. [RPi Pin Usage](#rpi-pin-usage)
12+
2. [Installation](#installation)
13+
1. [Website List](#website-list-upjson)
14+
3. [Configuration](#configuration)
15+
1. [LED Pins](#led-pins)
16+
2. [Email Config](#email-config)
17+
3. [Database Config](#database-config)
18+
4. [Virtual Environment](#virtual-environment--dependencies)
19+
4. [Cron Jobs](#initialize-cron-jobs)
20+
5. [Flask](#flask)
21+
1. [Run Flask App](#run-flask-app)
22+
2. [Web Service Endpoints](#web-service-endpoints)
23+
6. [Apache](#apache)
24+
7. [Backlog Items](#backlog-items)
25+
8. [Authors](#authors)
26+
9. [License](#license)
27+
28+
729
## Getting Started
830

931
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
@@ -12,6 +34,8 @@ Demo Pic of project in progress:
1234

1335
<img src="https://i.imgur.com/yYHUCZ2.jpg" alt="Website Uptime Monitor" width="700" />
1436

37+
38+
1539
### Hardware
1640

1741
- Raspberry Pi - I use Zero W for this project
@@ -80,7 +104,7 @@ If you go to the above URL, you will find that JSON file with that properly. Yo
80104

81105
Avoid having a blank line in your `sites.txt` file. I may put all of this in database tables at some point in the future.
82106

83-
### Configuration
107+
## Configuration
84108

85109
The below configurations are located in `config/config.sample.py` - before continuing, rename the file to `config.py` and adjust the values below. There are two main configuration categorie: Database and Email.
86110

@@ -121,7 +145,7 @@ EMAIL_CONFIG = {
121145

122146
Once you've made the edits, move onto the database config.
123147

124-
## Database Config
148+
### Database Config
125149

126150
Before creating the schema, edit `config/config.py` and update the `DATABASE_CONFIG` configurations with the database that you'll create in the next step:
127151

0 commit comments

Comments
 (0)