Skip to content

Commit

Permalink
Merge branch 'main' of github.com:Kaya-Sem/commandtrein
Browse files Browse the repository at this point in the history
  • Loading branch information
Kaya-Sem committed Dec 5, 2024
2 parents 049bdcf + 58daaf7 commit 37a5812
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)
Expand Down

0 comments on commit 37a5812

Please sign in to comment.