Add readme

8 years ago · bc5d169869
parent 5427f53196
commit bc5d169869
1 changed files with 13 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,13 @@
+# Eth ENS Namehash [![CircleCI](https://circleci.com/gh/flyswatter/eth-ens-namehash.svg?style=svg)](https://circleci.com/gh/flyswatter/eth-ens-namehash)
+
+A javascript library for generating ENS namehashes per spec https://github.com/ethereum/EIPs/issues/137
+
+# Does not yet work!
+
+## Usage
+
+```javascript
+var namehash = require('eth-ens-namehash')
+var hash = namehash('foo.eth')
+// '0xde9b09fd7c5f901e23a3f19fecc54828e9c848539801e86591bd9801b019f84f'
+```