From df73de24b1b20f738b66cf76699f1121498a9940 Mon Sep 17 00:00:00 2001 From: Luc Date: Wed, 4 Sep 2024 22:56:44 +0000 Subject: [PATCH] Introduce basic README --- packages/react/.gitignore | 1 - packages/react/README.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 packages/react/README.md diff --git a/packages/react/.gitignore b/packages/react/.gitignore index a204bab4..0d86917e 100644 --- a/packages/react/.gitignore +++ b/packages/react/.gitignore @@ -2,7 +2,6 @@ /cache /artifacts /coverage -README.md LICENSE .env.local diff --git a/packages/react/README.md b/packages/react/README.md new file mode 100644 index 00000000..70917743 --- /dev/null +++ b/packages/react/README.md @@ -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))