From 27f591f9e4981d57bd760016e1a4d4134703f13b Mon Sep 17 00:00:00 2001
From: Valentin Brandl <vbrandl@riseup.net>
Date: Tue, 16 Apr 2019 16:57:33 +0200
Subject: [PATCH] Add readme

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dc3b264
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Hits-of-Code
+
+Small webservice, that returns a badge of the Hits-of-Code of a git repository,
+as described by [Yegor
+Bugayenko](https://www.yegor256.com/2014/11/14/hits-of-code.html). Currently
+only GitHub repositories are supported, but it can be trivially extended to
+support other platforms such as GitLab or Bitbucket.
+
+## API
+
+The API is as simple as
+
+```
+https://<host>/github/<user>/<repo>
+```
+
+
+## TODO
+
+* Customization of badges (e.g. colors)
+* Support other platforms beside GitHub
+* Allow exclusion of certain files/globs from the HoC count