diff options
Diffstat (limited to 'contracts/ens/README.md')
| -rw-r--r-- | contracts/ens/README.md | 20 |
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 |