summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSam Tay <sam.chong.tay@gmail.com>2020-06-05 13:59:34 -0700
committerSam Tay <sam.chong.tay@gmail.com>2020-06-06 19:56:12 -0700
commitb06f305db319b90ff55e159a8538bac853ca2168 (patch)
treeac7e6559346f28c5cb4852a66b213732ab8b6d8e /README.md
parentca754e6254d9e0453dd0e02d700ea0ac3dd9d6a5 (diff)
Fetch and cache SE sites
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8a8c1c8..defc45f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
# so
**Note:** under development, not ready for prime time.
+
+### api keys
+According to the [StackExchange
+docs](https://api.stackexchange.com/docs/throttle), most users should be fine
+without generating a personal API key (10k requests per IP per day). If you do
+run into throttling issues, get a key
+[here](https://stackapps.com/apps/oauth/register) and tell `so` to use it:
+```
+so --set-api-key <KEY>
+```