Skip to content

Commit

Permalink
docs: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
harsxv committed Oct 2, 2024
1 parent dfab47a commit 0e29ac4
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Check out an online demo https://status.harry.id
type: http
host: https://github.com
url: https://github.com # (optional: URL review/clickable)
ssc: True # (optional if the server uses a self-signed certificate)
ssc: True # (optional: if the server uses a self-signed certificate)
expected_code: 200

- name: Google DNS
Expand All @@ -75,11 +75,11 @@ Check out an online demo https://status.harry.id
type: port
host: db.example.com
port: 5432
```
```
4. (Optional) Customize the `incidents.md` file to add any known incidents or maintenance schedules.
3. (Optional) Customize the `incidents.md` file to add any known incidents or maintenance schedules.

5. (Optional) Modify the `index.html.theme` and `history.html.theme` files to customize the look and feel of your status pages.
4. (Optional) Modify the `index.html.theme` and `history.html.theme` files to customize the look and feel of your status pages.

## Usage

Expand All @@ -88,7 +88,7 @@ Check out an online demo https://status.harry.id
python tinystatus.py
```

2. The script will generate two files:
2. The script will generate three files:
- `index.html`: The main status page
- `history.html`: The status history page
- `history.json`: The status history and timestamp data
Expand All @@ -100,7 +100,7 @@ Check out an online demo https://status.harry.id
```
- On Windows, you can use the Task Scheduler to run the script at startup.

4. Serve the generated HTML files using your preferred web server (e.g., Apache, Nginx, or a simple Python HTTP server for testing).
4. Serve the generated HTML files using your preferred web server (e.g., Apache, NGINX, or a simple Python HTTP server for testing).

## Using Docker

Expand All @@ -124,7 +124,7 @@ TinyStatus porting are available in:

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.
[Contributions](https://github.com/harsxv/tinystatus/contribute) are, of course, most welcome!

## License

Expand Down

0 comments on commit 0e29ac4

Please sign in to comment.