Skip to content

Commit

Permalink
Replace "name" with "slug" in README
Browse files Browse the repository at this point in the history
  • Loading branch information
RealOrangeOne committed Apr 25, 2024
1 parent aca0755 commit b4ef131
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Individual calendars can be protected by basic authentication if required (value

## Usage

Calendars are served based on their [name](#configuration), at `/{name}.ics`.
Calendars are served based on their [slug](#configuration), at `/{slug}.ics`.

Additional events cen be added at offsets from the original date using the `offset_days` configuration. Events can only be offset ±10 years.

Expand All @@ -20,7 +20,7 @@ To do this, run:
calmerge write ./calendars
```

Each calendar will be saved as a `.ics` file based on its name to the `./calendars` directory.
Each calendar will be saved as a `.ics` file based on its slug to the `./calendars` directory.

## Deployment

Expand All @@ -45,7 +45,7 @@ Example configuration:

```toml
[[calendar]]
name = "python"
slug = "python"
urls = [
"https://endoflife.date/calendar/python.ics",
]
Expand Down

0 comments on commit b4ef131

Please sign in to comment.