Added a basic README

This commit is contained in:
Alex Kelly 2020-01-06 11:36:02 -05:00
parent a1d67cedb8
commit 6c0e596a09

21
README.md Normal file
View file

@ -0,0 +1,21 @@
Chainlink
=========
Chainlink is a utility that will run on a webserver to handle crypto-backed domains. Specifically this works with [Unstoppable Domains](https://unstoppabledomains.com)
Installation
============
To install this on your own server:
#. Clone this repository
#. Install the python dependancies via `pip install -r requirements.txt`
#. Run the server with `./chainlink.py`
#. You can now hit the app at [http://localhost:5000/](http://localhost:5000)
Testing on a running instance
=============================
Assuming that it is running (I could be messing with it, or it might just be
broken), you may try this without installing by going to
[https://chainlink.arachnitech.com/](https://chainlink.arachnitech.com/)