Update readme

This commit is contained in:
Valérian Galliat 2021-10-16 09:55:28 -04:00
commit 9898e4e853

View file

@ -55,6 +55,20 @@ Commands:
help [command] Display help for command.
```
A typical flow will look like this:
```sh
ffs -c ~/.ffs-creds.json oauth
ffs -c ~/.ffs-creds.json colections
ffs -c ~/.ffs-creds.json get bookmarks --full
```
During authentication, this will create `~/.ffs-creds.json` to store the
credentials necessary to access Firefox Sync.
Further commands read credentials from this file to use that session to
query the API.
## Authentication
### Email and password