From b2f0aa1e4e1e4fcfcfc17e221254217699e5e6fd Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Sat, 3 Oct 2020 14:11:06 +0200 Subject: [PATCH] Speak about workflows a bit --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index b56ee97..e4d877c 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,25 @@ The APIKEY is the contents of the file APIKEY.txt in the etherpad folder. The settings are placed in a file called `.etherpump/settings.json` and are used (by default) by future commands. +## Common Workflows + +### Text+Meta performance wrangling + +If you have a lot of pads, you might want to try the following to speed things +up. This example is something we do at Varia. Firstly, you download all the +pads text + metadata as the only formats. This is likely what you want when +you're trying to work directly with the text. You can do that like so: + +```bash +$ etherpump pull --text --meta +``` + +The key here is to get the `--meta` so that etherpump is able to read quickly +skip it on the following run if there are no new revisions. So, in practice, +you get a slower first run and faster following runs as more pads are skipped +from actually doing a file system write to save the contents which we already +have. + ## Library API Example Etherpump can be used as a library.