Browse Source

Add a README

Thomas Jost 3 years ago
parent
commit
5a642c5b11
Signed by: Thomas Jost <schnouki@schnouki.net> GPG Key ID: 3F3B990246141762
1 changed files with 54 additions and 0 deletions
  1. 54
    0
      README.md

+ 54
- 0
README.md View File

@@ -0,0 +1,54 @@
1
+# islas
2
+
3
+Welcome to islas! Islas is a small CLI application that makes it possible to get
4
+timetables for the public transporation system in Nancy, France (Réseau Stan)
5
+very quickly. It uses the same APIs as the Android application.
6
+
7
+
8
+## Installation
9
+
10
+- Install [Go](https://golang.org/), [Glide](https://glide.sh/),
11
+  [git](https://git-scm.org/) and [make](https://www.gnu.org/software/make/)
12
+- Clone the repository: `git clone https://code.schnouki.net/schnouki/islas.git && cd islas`
13
+- Build it: `make`
14
+
15
+
16
+## Usage
17
+
18
+- The first time you run islas, you'll need to update its internal database:
19
+  `./islas update`
20
+- Then, add a few stops to your favorites: `./islas add`
21
+- Now you can get their timetables: `./islas`
22
+
23
+You can change the output format with the `-f` (`--format`) option: `-f simple`,
24
+`-f color`, `-f pretty`. The default is to use the `pretty` format.
25
+
26
+In all colorful formats, the passing times are in green if they are real-time
27
+estimations (based on the actual bus/tram GPS location), or in the normal text
28
+color if they are from the standard, theoretical timetables. Long story short:
29
+green is better :)
30
+
31
+
32
+## License
33
+
34
+MIT
35
+
36
+
37
+## About the data
38
+
39
+This application is *not* endorsed by Réseau Stan, and has *no* authorization to
40
+use their data or their webservices.
41
+
42
+While this application tries really hard not to do anything funny and to behave
43
+like the Android application, so that it won't cause any issue (bug, slowness,
44
+increased load) on the servers that host the timetables webservice, there can be
45
+no guarantee about that. **Use it at your own risk**.
46
+
47
+
48
+## About the webservice
49
+
50
+The timetables webservice is developed by Cityway and hosted by Réseau Stan. As
51
+far as I know there is no public documentation for them (except for another
52
+reverse-engineering effort from the [TagDroid](https://github.com/Tagdroid)
53
+project). Another (more official-looking) project that uses this webservice:
54
+[MetromobiliteWS](https://github.com/Metromobilite/MetromobiliteWS).

Loading…
Cancel
Save