Skip to content

Commit

Permalink
Introduce basic README
Browse files Browse the repository at this point in the history
  • Loading branch information
lucemans committed Sep 4, 2024
1 parent 7b42837 commit df73de2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
1 change: 0 additions & 1 deletion packages/react/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
/cache
/artifacts
/coverage
README.md
LICENSE

.env.local
18 changes: 18 additions & 0 deletions packages/react/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# @ensdomains/ensjs-react

React hooks & utilities to interact with the Ethereum Name Service using ENSjs

## Installation

After installing [wagmi](https://wagmi.sh), simply run

```sh
pnpm install @ensdomains/ensjs-react
```

## Hooks

- `useEnsAvailable` - checks availability (uses [getAvailable](docs/public/function.getAvailable.md))
- `useEnsResolverInterfaces` - check supportsInterface on resolver (uses [getSupportedInterfaces](docs/public/function.getSupportedInterfaces.md))
- `useNamesForAddress` - lists names from subgraph (uses [getNamesForAddress](docs/subgraph/function.getNamesForAddress.md))
- `useDecodedName` - decodes name using subgraph (uses [getDecodedName](docs/subgraph/function.getDecodedName.md))

0 comments on commit df73de2

Please sign in to comment.