From 84100ee9812b93b38f1cc72b26d1213b4caa4d5f Mon Sep 17 00:00:00 2001 From: Alex Kelly Date: Mon, 6 Jan 2020 11:45:29 -0500 Subject: [PATCH] Added more usage detail to README --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0329263..77cbf99 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ 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) +Chainlink is a utility that will run on a webserver to handle crypt-backed +domains Specifically this works with +[Unstoppable Domains](https://unstoppabledomains.com) +This utilizes public IPFS gateways to display IPFS content, or will redirect to +whatever the URL is set to in the Unstoppable Domain management. Installation ============ @@ -11,11 +15,25 @@ To install this on your own server: 1. Clone this repository 2. Install the python dependancies via `pip install -r requirements.txt` 3. Run the server with `./chainlink.py` -4. You can now hit the app at [http://localhost:5000/](http://localhost:5000) +4. You can now hit the app at 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/) +https://chainlink.arachnitech.com/ + +URL Patterns +============ + +The general format is http://localhost:5000// +where is a .crypto or .zil name registered with Unstoppable Domains and + can be +* html - uses the IPFS hash set in Unstoppable Domains management +* redir - uses the redirect_url set in Unstoppable Domains management +* raw - displays an HTML table view of the full JSON returned from Unstoppable + Domains API + +The default action is "html", so if you don't specify anything it will attempt +to use that field.