Skip to content

Commit

Permalink
Improve flow diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
calvinmclean committed Sep 1, 2024
1 parent 9fafe91 commit f98453d
Show file tree
Hide file tree
Showing 5 changed files with 1,347 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This system is designed to be flexible for all types of gardening. Here are a fe

## How It Works

![Garden](docs/_images/FlowDiagram.png?raw=true)
![Garden](docs/_images/GardenApp.png?raw=true)

### Garden Server
This Go application is contained in the [`garden-app`](./garden-app) directory and consists of a CLI and web backend for interacting with the garden controller. It implements all logic and orchestrates the separate systems.
Expand Down Expand Up @@ -93,7 +93,7 @@ Use Docker Compose to easily run everything and try it out! This will run all se
- The "Garden App" dashboard contains application metrics for resource usage, HTTP stats, and others
- The "Garden Dashboard" dashboard contains more interesting data that comes from the `garden-controller` to show uptime and a watering history. You should see the recent 3 second watering event here

6. Access the UI at http://localhost:8080/gardens
6. Access the UI at http://localhost:8080/gardens

And that's it! I encourage you to check out the additional documentation for more detailed API usage and to learn about all of the things that are possible.
Expand All @@ -104,4 +104,4 @@ This project includes an HTMX UI served by the Go application.
## Compile controller
```
pio run -t upload
```
```
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This system is designed to be flexible for all types of gardening. Here are a fe

## How It Works

![Garden](_images/FlowDiagram.png?raw=true)
![Garden](_images/GardenApp.png?raw=true)

### Garden Server
This Go application is contained in the [`garden-app`](./garden-app) directory and consists of a CLI and web backend for interacting with the garden controller. It implements all logic and orchestrates the separate systems.
Expand Down
Binary file removed docs/_images/FlowDiagram.png
Binary file not shown.
Loading

0 comments on commit f98453d

Please sign in to comment.