From 9898e4e85386b8940c82dfd50eb423324a0ec6a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Val=C3=A9rian=20Galliat?= Date: Sat, 16 Oct 2021 09:55:28 -0400 Subject: [PATCH] Update readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 4f81d38..e7ef7e7 100644 --- a/README.md +++ b/README.md @@ -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