plugins.github: Add comment with example config

Tue, 18 Aug 2015 17:05:30 +0200

author
Kim Alvefur <zash@zash.se>
date
Tue, 18 Aug 2015 17:05:30 +0200
changeset 133
9d75333c8a3f
parent 131
51fd36d01b27
child 134
2c49724e0cca

plugins.github: Add comment with example config

plugins/github.lua file | annotate | diff | comparison | revisions
--- a/plugins/github.lua	Tue Aug 18 15:53:48 2015 +0200
+++ b/plugins/github.lua	Tue Aug 18 17:05:30 2015 +0200
@@ -1,3 +1,13 @@
+-- Plugin for querying a Github issue-tracker
+--
+-- Example config:
+-- github = {
+--   ["project@conference.example.org"] = {
+--     user = "TheArchitect";
+--     repo = "TheMatrix";
+--   }
+-- }
+
 local url = require"socket.url";
 local json = require"util.json";
 local http = require"net.http";

mercurial