Added more usage detail to README
This commit is contained in:
parent
369b7a94af
commit
84100ee981
1 changed files with 21 additions and 3 deletions
24
README.md
24
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/<domain>/</action>
|
||||
where <domain> is a .crypto or .zil name registered with Unstoppable Domains and
|
||||
<action> 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.
|
||||
|
|
Loading…
Reference in a new issue