diff --git a/README.md b/README.md index 38862f2..025d8c4 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,11 @@ Commandtrein is a command-line interface (CLI) tool designed to access and display timetables and route information for SNCB (Belgian Railways) directly from your terminal. -See also: [commandlijn](https://github.com/Command-Transport/commandlijn) - ## Features - Timetables: retrieve and display the current timetable for any SNCB station. - Routes: Get detailed connections and travel times between two SNCB stations. +- Shortcuts: Configure and use shortcuts for frequently used routes. ![commandtrein](https://github.com/user-attachments/assets/f4343bf1-d8e4-4151-a2d3-4e4289307ad3) @@ -21,6 +20,17 @@ See also: [commandlijn](https://github.com/Command-Transport/commandlijn) [Shell completion](https://github.com/Kaya-Sem/commandtrein/wiki/Shell-Tab-Completion) +## Configuration +Commandtrein uses a YAML configuration file located at `~/.config/commandtrein/config.yaml`. This files stores your shortcuts for frequent routes. + +Example configuration: +```yaml +shortcuts: + work: + station1: "Brussel-Midi" + station2: "Antwerpen-Centraal" +``` + ## Changelog [changelog.md](https://github.com/Kaya-Sem/commandtrein/blob/main/CHANGELOG.md)