From 6c0e596a09b046625123f20a63b8f1a45c10d1fd Mon Sep 17 00:00:00 2001 From: Alex Kelly Date: Mon, 6 Jan 2020 11:36:02 -0500 Subject: [PATCH] Added a basic README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ccc2ec2 --- /dev/null +++ b/README.md @@ -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/)