From 86afe423209d00fc135c140b08e1b09e2c3affcc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20Soko=C5=82owski?= <jakub@status.im>
Date: Tue, 6 Aug 2019 15:05:30 -0400
Subject: [PATCH] add basic README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Jakub Sokołowski <jakub@status.im>
---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d505d61
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Description
+
+This repo defines the infrastructure necessary for https://go.status.im/.
+
+# Details
+
+This is achieved by use of [CloudFlare Workers](https://developers.cloudflare.com/workers/) which are a:
+
+>serverless execution environment that allows you to create entirely new applications ... without configuring or maintaining infrastructure.
+
+The whole scrip is [`go_vanity.js`](go_vanity.js) which simply generates some basic HTML which includes the necessary `<meta>` tags for Go Vanty imports which look like this:
+```html
+<meta name="go-import" content="go.status.im/whisper git https://github.com/status-im/whisper ">
+```
+
+# Todo
+
+* Make the page more fancy?
+* Maybe use a tempalting engine like a civilized human being
+
+# Links
+
+* https://discuss.status.im/t/vanity-imports-for-our-go-repositories/1308