feat: add readme (#11)

Signed-off-by: michalrozekariane <[email protected]>

README.md

@@ -1 +1,37 @@
-# airdrop-list-builder
+# Airdrop List Verifier
+
+The `Airdrop List Verifier` is a utility that simplifies the process of organizing airdrops for Hedera tokens. Users can input a Token ID and a list of account IDs to which they wish to airdrop tokens. The application generates a list of addresses either associated with the token or having available auto-association slots, ensuring efficient and targeted airdrops.
+
+## Usage
+
+Get started by installing dependencies and running the project:
+
+```shell
+npm install
+npm run dev
+```
+
+Input the Token ID and account IDs list in the format required by the application to build your list of eligible recipients.
+
+## Technologies
+
+This project was developed with React and Typescript, using some ready-made UI components from shadcn (https://ui.shadcn.com/).
+There's no need to set any `.env` variables.
+
+## Contributing
+
+How to contribute to this project:
+
+- Create a fork of this repo on GitHub.
+- Clone that forked copy using GitHub.
+- Make your changes on a new branch.
+- Submit a PR against the main branch of this copy of the git repo.
+
+## Links
+
+- API Reference: REST API [Link](https://docs.hedera.com/hedera/sdks-and-apis/rest-api)
+- Swagger UI: Hedera Mirror Node REST API [Link](https://testnet.mirrornode.hedera.com/api/v1/docs/)
+
+## Licence
+
+MIT

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "airdrop-list-builder",
-  "homepage": "https://Ashe-Oro-Accelerator.github.io/airdrop-list-builder",
+  "name": "airdrop-list-verifier",
+  "homepage": "https://Ashe-Oro-Accelerator.github.io/airdrop-list-verifier",
   "private": true,
   "version": "0.0.0",
   "type": "module",