add basic README.md

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2019-08-06 15:05:30 -04:00
parent 5d0d24b45d
commit 86afe42320
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
1 changed files with 23 additions and 0 deletions

23
README.md Normal file
View File

@ -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