From d13177275131a84d507c1f13790aca5007d5e5b3 Mon Sep 17 00:00:00 2001 From: Kaya-Sem <73200952+Kaya-Sem@users.noreply.github.com> Date: Sat, 28 Sep 2024 15:01:29 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb8e84c..177ec47 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,13 @@ To quickly install commandtrein using go, run the following command: go install github.com/Kaya-Sem/commandtrein@latest ``` -This will download and install commandtrein and make it avaible in your `$GOPATH/bin` directory. Ensure that this directory is included in your system's `PATH` environment variable. +This will download and install commandtrein and make it available in your `$GOPATH/bin` directory. Ensure that this directory is included in your system's `PATH` environment variable. -#### 2. Install from source +#### 2. Compiled binaries + +[releases](https://github.com/Kaya-Sem/commandtrein/releases) (windows is untested) + +#### 3. Install from source If you prefer to build commandtrein from source, follow these steps: ```bash From 34b3fdb057a2b6d29787bd7b13ee1310bc51be90 Mon Sep 17 00:00:00 2001 From: Kaya-Sem <73200952+Kaya-Sem@users.noreply.github.com> Date: Sat, 28 Sep 2024 15:05:09 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 177ec47..f7f6e7f 100644 --- a/README.md +++ b/README.md @@ -76,4 +76,4 @@ To filter results, you will have to use tools like grep. Filtering is planned in #### Acknowledgements -Commandtrein leverages the iRails API, an open-source API for accessing real-time data from SNCB. We extend our thanks to the iRails team for their excellent service. +Commandtrein leverages the iRails API, an open-source API for accessing real-time data from SNCB. From 72cb3fc9f91068353131b2604ad2bb7f44219a30 Mon Sep 17 00:00:00 2001 From: Kaya-Sem <73200952+Kaya-Sem@users.noreply.github.com> Date: Sun, 29 Sep 2024 15:12:21 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index f7f6e7f..3844e15 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ Commandtrein is a command-line interface (CLI) tool designed to access and displ See also: [commandlijn](https://github.com/Command-Transport/commandlijn) +## Roadmap +- **Stylistic Improvements:** I appreciate any stylistic advice to enhance the user experience and code quality. +- **Upcoming Features:** + - Filtering station results directly within the CLI. + - shell completion for stations + ## Features - Timetables: retrieve and display the current timetable for any SNCB station. - Routes: Get detailed connections and travel times between two SNCB stations.