From 3f9fee2a2e962e066e08a636f538521b10eb8ee2 Mon Sep 17 00:00:00 2001
From: Clayton Yochum <claytonjy@gmail.com>
Date: Fri, 30 Aug 2019 12:53:30 -0400
Subject: Add Docker section to README.

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 9f68a97..8633cf3 100644
--- a/README.md
+++ b/README.md
@@ -117,6 +117,43 @@ you can use ``pip`` with the following command:
 pip install --user bs4 requests PyPDF2 titlecase pdfplumber unidecode
 ```
 
+## Docker
+
+You can also use our Dockerfile to avoid installing dependencies on your machine. You will need `git` and `docker` installed.
+
+First clone this repository with `git clone` and `cd` inside of it, then build the container:
+
+```bash
+docker build -t arxiv2remarkable .
+```
+
+### Authorization
+
+If you already have a `~/.rmapi` file, you can skip this section. Otherwise we'll use `rmapi` to create it.
+
+```bash
+touch ${HOME}/.rmapi
+docker run --rm --it -v "${HOME}/.rmapi:/root/.rmapi:rw" --entrypoint=rmapi arxiv2remarkable version
+```
+
+which should end with output like
+
+```bash
+ReMarkable Cloud API Shell
+rmapi version: 0.0.5
+```
+
+### Usage
+
+Use the container by replacing `python arxiv2remarkable.py` with `docker run --rm -v "${HOME}/.rmapi:/root/.rmapi:rw" arxiv2remarkable`, e.g.
+```
+# print help and exit
+docker run --rm -v "${HOME}/.rmapi:/root/.rmapi:rw" arxiv2remarkable --help
+
+# equivalent to above usage via `python`
+docker run --rm -v "${HOME}/.rmapi:/root/.rmapi:rw" arxiv2remarkable -v https://arxiv.org/abs/1811.11242
+```
+
 # Notes
 
 License: MIT
-- 
cgit v1.2.3