varia/etherpump
14
0
Fork 0
Code Issues 15 Pull Requests Releases Activity

Speak about workflows a bit

Browse Source
This commit is contained in:
Luke Murphy 2020-10-03 14:11:06 +02:00
parent bff0692c2b
commit b2f0aa1e4e
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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.