aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/ens/README.md
diff options
context:
space:
mode:
authorNick Johnson <arachnid@notdot.net>2016-08-26 20:00:25 +0800
committerNick Johnson <arachnid@notdot.net>2016-08-30 00:30:17 +0800
commit6976e602f6553b6f535b44123c44edb6b65af4b2 (patch)
treefac350d4bcad84416e2059b3951d392edb676c81 /contracts/ens/README.md
parent5fc032a9d16ac6ea1dc020f06e44c24c94a361a7 (diff)
downloaddexon-6976e602f6553b6f535b44123c44edb6b65af4b2.tar.gz
dexon-6976e602f6553b6f535b44123c44edb6b65af4b2.tar.zst
dexon-6976e602f6553b6f535b44123c44edb6b65af4b2.zip
contracts/ens: Add ENS contract binding
Diffstat (limited to 'contracts/ens/README.md')
-rw-r--r--contracts/ens/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/contracts/ens/README.md b/contracts/ens/README.md
new file mode 100644
index 000000000..68c5e9769
--- /dev/null
+++ b/contracts/ens/README.md
@@ -0,0 +1,20 @@
+# Swarm ENS interface
+
+## Usage
+
+Full documentation for the Ethereum Name Service [can be found as EIP 137](https://github.com/ethereum/EIPs/issues/137).
+This package offers a simple binding that streamlines the registration arbitrary utf8 domain names to swarm content hashes.
+
+## Development
+
+The SOL file in contract subdirectory implements the ENS root registry, a simple first-in-first-served registrar for the root namespace, and a simple resolver contract; they're used in tests, and can be used to deploy these contracts for your own purposes.
+
+The solidity source code can be found at [github.com/arachnid/ens/](https://github.com/arachnid/ens/).
+
+The go bindings for ENS contracts are generated using `abigen` via the go generator:
+
+```shell
+godep go generate ./swarm/services/ens
+```
+
+see the preprocessor directives in leading comments of ens.go and ens_test.go