Merge pull request #72 from leancodepl/docs/24-poeditor-token-env

Put instructions on exporting POEDITOR_TOKEN in README
leancodepl · Apr 7, 2023 · eb15066 · eb15066
2 parents c957735 + 59bdcc1
commit eb15066
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,18 @@ brew tap leancodepl/poe2arb
 brew install poe2arb
 ```
 
+### `POEDITOR_TOKEN`
+
+The `poe2arb poe` command requires a POEditor read-only API token.
+It's available in [Account settings > API access][poeditor-tokens].
+
+You can export this token in your `~/.bashrc` or `~/.zshrc` so that it's always
+available:
+
+```bash
+export POEDITOR_TOKEN="YOUR_API_TOKEN_HERE"
+```
+
 ## Usage
 
 `poe2arb` operates on POEditor's _JSON_ (not _JSON key-value_) export file