docs: translate README to English and add mobile-login info
Translate French content in README to English and add information about how to fetch club_id and token using the mobile-login command.
This commit is contained in:
34
README.md
34
README.md
@@ -1,9 +1,9 @@
|
|||||||
# myice
|
# myice
|
||||||
|
|
||||||
## intro
|
## introduction
|
||||||
|
|
||||||
Avec tout ça on va aller chercher sur MyIce les planning des gamins et générer
|
With this tool, you can fetch kids' schedules from MyIce and generate
|
||||||
les pdf qu'on veut
|
the PDFs you need.
|
||||||
|
|
||||||
## install
|
## install
|
||||||
|
|
||||||
@@ -42,15 +42,27 @@ userid = 12345
|
|||||||
token = token1
|
token = token1
|
||||||
club_id = 172
|
club_id = 172
|
||||||
|
|
||||||
[isaac]
|
[second_kid]
|
||||||
username = isaac@example.com
|
username = charlie@example.com
|
||||||
password = password2
|
password = password2
|
||||||
userid = 67890
|
userid = 67890
|
||||||
token = token2
|
token = token2
|
||||||
club_id = 186
|
club_id = 186
|
||||||
```
|
```
|
||||||
|
|
||||||
## récupérer le schedule
|
Note: The `userid`, `token`, and `club_id` fields are optional. If you don't
|
||||||
|
have them, the tool can fetch them automatically using the mobile-login
|
||||||
|
command (see below).
|
||||||
|
|
||||||
|
To fetch the `token` and `club_id` using mobile-login:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
myice mobile-login
|
||||||
|
```
|
||||||
|
|
||||||
|
This will output the necessary information that you can add to your `myice.ini` file.
|
||||||
|
|
||||||
|
## fetch schedule
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
myice schedule -o schedule.json
|
myice schedule -o schedule.json
|
||||||
@@ -66,7 +78,7 @@ myice schedule -o schedule.json --config-section isaac
|
|||||||
|
|
||||||
### listing
|
### listing
|
||||||
|
|
||||||
Pour récupérer les event des U13 Elite par example:
|
To fetch events for U13 Elite for example:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
❯ myice search "U13 (Elite)"
|
❯ myice search "U13 (Elite)"
|
||||||
@@ -92,11 +104,11 @@ practice: On-Ice Patinoire des Vernets - Patinoire Extérieure
|
|||||||
game: Saison HC Ajoie
|
game: Saison HC Ajoie
|
||||||
```
|
```
|
||||||
|
|
||||||
Et on récupère la convoc du match:
|
And we retrieve the match roster:
|
||||||
|
|
||||||
### match
|
### match
|
||||||
|
|
||||||
alors pour avoir la convocation du match contre Ajoie, l'id c'est 117015:
|
To get the roster for the match against Ajoie, the ID is 117015:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
❯ myice game 117015
|
❯ myice game 117015
|
||||||
@@ -110,9 +122,9 @@ To use a specific configuration section:
|
|||||||
❯ myice game 117015 --config-section isaac
|
❯ myice game 117015 --config-section isaac
|
||||||
```
|
```
|
||||||
|
|
||||||
### entraînement
|
### practice
|
||||||
|
|
||||||
et pour la convoc d'un entraînement:
|
And for a practice roster:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
❯ myice practice 561855
|
❯ myice practice 561855
|
||||||
|
|||||||
Reference in New Issue
Block a user