Skip to content

Commit

Permalink
docs: improve clarity and formatting of README.md usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
revelaction committed Sep 21, 2024
1 parent fc60213 commit 18a0ebd
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,12 @@ defined in the config file.

# Usage

The basic usage involves having a private repository containing iCalendar (`.ics`) files. You need to provide the SSH key and repository address in the configuration TOML file. Alternatively, you can provide a path in the current filesystem. For more details, refer to the [Configuration File](configuration.md). Once configured, you can run the daemon to start processing the calendar events.
The basic usage involves having a private repository containing iCalendar
(`.ics`) files. You need to provide the SSH key and repository address in the
configuration TOML file. Alternatively, you can provide a path in the current
filesystem. For more details, refer to the [Configuration
File](configuration.md). Once configured, you can run the daemon to start
processing the calendar events.

# Features

Expand Down

0 comments on commit 18a0ebd

Please sign in to comment.