Skip to content

Commit 8dfab6e

Browse files
committed
Update docs
1 parent 5cfce71 commit 8dfab6e

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ An external-facing, FastAPI-based front-end for accessing some Leigh Hackspace d
99
| `BASE_URL` | `http://localhost:8000` | URL base where the application will be accessible at |
1010
| `PROMETHEUS_INSTANCE` | `http://prometheus:9090` | Endpoint URL for the Prometheus instance |
1111
| `HOMEASSISTANT_INSTANCE` | `http://homeassistant:8123` | Endpoint URL for the Home Assistant instance |
12-
| `HOMEASSISTANT_TOKEN` | `PydanticUndefined` | Token used to access the Home Assistant API |
12+
| `HOMEASSISTANT_TOKEN` | | Token used to access the Home Assistant API |
1313
| `HACKSPACE_NAME` | `Leigh Hackspace` | Name of the hackspace |
1414
| `HACKSPACE_LOGO_URL` | `https://raw.githubusercontent.com/leigh-hackspace/logos-graphics-assets/master/logo/rose_logo.svg` | URL to the logo for the hackspace |
1515
| `HACKSPACE_WEBSITE_URL` | `https://leighhack.org` | URL to the hackspace's website |
@@ -20,7 +20,7 @@ An external-facing, FastAPI-based front-end for accessing some Leigh Hackspace d
2020
| `HACKSPACE_OPEN_ENTITY` | `binary_sensor.hackspace_open_multi` | Entity ID of the Home Assistant device to indicate open status |
2121
| `HACKSPACE_PUBLIC_CALENDAR` | `calendar.public_events` | The entity ID of the Home Assistant public calendar |
2222
| `HACKSPACE_MEMBER_CALENDAR` | `calendar.member_events` | The entity ID of the Home Assistant member calendar |
23-
| `SENSORS_PRESSURE_ENABLED` | `None` | Enable pressure sensors |
23+
| `SENSORS_PRESSURE_ENABLED` | `False` | Enable pressure sensors |
2424

2525
## Endpoints
2626

@@ -34,6 +34,10 @@ Simple health endpoint.
3434

3535
Outputs a standard [SpaceAPI](https://spaceapi.io) endpoint.
3636

37+
### `/events`
38+
39+
Dumps a JSON format list of events upcoming in the next 30 days.
40+
3741
### `/events.ics`
3842

39-
Dumps an iCal format list of events upcoming in the next 30 days.
43+
Dumps a iCal format list of events upcoming in the next 30 days.

0 commit comments

Comments
 (0)