From d07c6f16fb161e6a7d1d467b280b454f3961b60b Mon Sep 17 00:00:00 2001 From: Sam Willcocks Date: Sun, 2 Aug 2020 16:22:42 +0100 Subject: [PATCH] Add readme --- readme.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..b6b0ba2 --- /dev/null +++ b/readme.md @@ -0,0 +1,12 @@ +# Intro +A very simple prometheus exporter for getting the follower count of twitter accounts, for the intersection of "people who care about their twitter follower count" and "people who run their own monitoring infrastructure". + +# Usage +`twitter-prometheus`. That's it. If you want, you can specify a listenaddr with `-listen`. It defaults to `:9700`. + +# Metrics +- `/metrics` - the usual built in metrics for go programs +- `/probe?screen_name=foo` - the follower count for twitter user with screen name foo + +# How it do +Uses the `https://cdn.syndication.twimg.com/widgets/followbutton/info.json` *unauthenticated* JSON API. Twitter may well turn this off or rate limit aggressively. \ No newline at end of file