diff --git a/.github/banner1.png b/.github/banner1.png new file mode 100644 index 0000000..349632a Binary files /dev/null and b/.github/banner1.png differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cdcf6b9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +ens-tools - All your bits and bobs for doing ENS +Copyright (C) 2023 Luc van Kampen + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + +See the GNU Lesser General Public License at diff --git a/README.md b/README.md index 71f3249..a79029a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ -# ens-tools +[![ens-tools](.github/banner1.png)](https://www.npmjs.com/package/ens-tools) -This is a cute little wholesome readme awaiting some attention 😊😇. +
+ +> **Note** +> +> This project aims to extend the functionality of [wagmi](https://wagmi.sh/) as well as provide additional utility for the ENS ecosystem. + +## Features + +- 🪝 React Hook for Multichain Addresses +- 💾 React Hook for getting Records +- 💼 Easily Normalize Records +- 📝 Easily truncate Ethereum Addresses + +...and a lot more. + +## Documentation + +For documentation. Stick to the Typescript Intellisense. + +## Installation + +Install ens-tools and thats about it. + +```bash +npm install ens-tools +``` + +## License + +[LGPL-3.0](/LICENSE) License