Skip to content

Commit

Permalink
improve README with Usage and Prerequisites sections
Browse files Browse the repository at this point in the history
  • Loading branch information
divulgacheur committed Apr 5, 2021
1 parent 9a5ae6a commit dc6027a
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# sncf-smart-location
Display train speed, maxspeed and name of current railway where your train (TGV or Intercités) is located.

Display train speed, max speed and name of current railway where your train (TGV or Intercités) is located.

Based on OpenStreetMap data, using Overpass-API

You need to be connected to the Wi-Fi hostpost ( *_SNCF_WIFI_INTERCITES* or *_SNCF_WIFI_INOUI*)
## Prerequisites

You need to be connected to the Wi-Fi hotspot of your train (`_SNCF_WIFI_INTERCITES` or `_SNCF_WIFI_INOUI`)
Make sure you have been authenticated through the `wifi.sncf` portal.

## Usage

Run with

```
$ bash sncf-smart-location.sh
```


0 comments on commit dc6027a

Please sign in to comment.