Skip to content

Commit

Permalink
Introduce README banner (#2)
Browse files Browse the repository at this point in the history
Co-authored-by: Luc <[email protected]>
Co-authored-by: imvlan <[email protected]>
  • Loading branch information
3 people authored Apr 29, 2023
1 parent e2a65cd commit 8584e17
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 2 deletions.
Binary file added .github/banner1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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 <https://www.gnu.org/licenses/lgpl-3.0>
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 😊😇.
<br>

> **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

0 comments on commit 8584e17

Please sign in to comment.