aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2020-11-08 15:17:14 +0000
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2020-11-08 15:17:14 +0000
commit284495561acb8b1bfd79cd41c88dd478e7e871a5 (patch)
treeca942b079aef830423426b1f793ba42c6f5d5758 /README.md
parentFix downloads badge (diff)
downloadpaper2remarkable-284495561acb8b1bfd79cd41c88dd478e7e871a5.tar.gz
paper2remarkable-284495561acb8b1bfd79cd41c88dd478e7e871a5.zip
Expand docker authentication instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 18 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6ee330d..6892eaa 100644
--- a/README.md
+++ b/README.md
@@ -229,19 +229,31 @@ docker build -t p2r .
### Authorization
-If you already have a `~/.rmapi` file, you can skip this section. Otherwise
-we'll use `rmapi` to create it.
+``paper2remarkable`` uses [rMapi](https://github.com/juruen/rmapi) to sync
+documents to the reMarkable. The first time you run ``paper2remarkable`` you
+will have to authenticate rMapi using a one-time code provided by reMarkable.
+By default, rMapi uses the ``${HOME}/.rmapi`` file as a configuration file to
+store the credentials, and so this is the location we will use in the commands
+below. If you'd like to use a different location for the configuration (for
+instance, ``${HOME}/.config/rmapi/rmapi.conf``), make sure to change the
+commands below accordingly.
+
+If you already have a `~/.rmapi` file with the authentication details, you can
+skip this section. Otherwise we'll create it and run ``rmapi`` in the docker
+container for authentication:
```bash
-touch ${HOME}/.rmapi
-docker run --rm -i -t -v "${HOME}/.rmapi:/home/user/.rmapi:rw" --entrypoint=rmapi p2r version
+$ touch ${HOME}/.rmapi
+$ docker run --rm -i -t -v "${HOME}/.rmapi:/home/user/.rmapi:rw" --entrypoint=rmapi p2r version
```
-which should end with output like
+This command will print a link where you can obtain a one-time code to
+authenticate rMapi and afterwards print the rMapi version (the version number
+may be different):
```bash
ReMarkable Cloud API Shell
-rmapi version: 0.0.5
+rmapi version: 0.0.12
```
### Usage