Skip to content

Commit 0a539e6

Browse files
authored
Update README.md
1 parent d1ebbcf commit 0a539e6

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,40 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
This is a Next JS app that allows users to deploy supertokens from ERC20 tokens
22

3-
## Getting Started
3+
## Getting Started:
44

5-
First, run the development server:
5+
First, clone the app, install the packages and run the development server:
66

7-
```bash
8-
npm run dev
9-
# or
7+
```
8+
git clone
9+
yarn install
1010
yarn dev
1111
```
1212

13-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
13+
## Packages and Libraries:
14+
15+
- ![Wagmi](https://wagmi.sh/react/getting-started): - Used for network connections, token data, and executing blockchain transactions.
16+
- ![ConnectKit](https://docs.family.co/connectkit): - Used to connect wallet to application.
17+
- ![ANTD](https://ant.design/docs/react/introduce): - UI library, used for tables, layout and buttons.
18+
19+
## How To Use:
1420

15-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
21+
1 - Connect your wallet:
1622

17-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
23+
![image](https://user-images.githubusercontent.com/69639595/211585016-24bdf0ca-e3ef-4b3f-8ea5-dd15bc343a73.png)
1824

19-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
25+
2 - Input your ERC20 token address from any network:
2026

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
27+
![image](https://user-images.githubusercontent.com/69639595/211585152-69983c32-e845-4270-9584-54579c21b9d6.png)
2228

23-
## Learn More
29+
3 - Tables with token data will populate, when ready click the deploy supertoken button:
2430

25-
To learn more about Next.js, take a look at the following resources:
31+
![image](https://user-images.githubusercontent.com/69639595/211585442-2d58d032-8aad-48dc-8f79-c5c565b60ae4.png)
2632

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
33+
4 - When token is deployed, you can check the transaction Link, supertoken Link on your network scan and check the token on Superfluid console:
2934

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
35+
![image](https://user-images.githubusercontent.com/69639595/211585769-415d8c0e-ae1d-40ea-8b24-83bea18bf228.png)
3136

32-
## Deploy on Vercel
37+
5 - Check superfluid console for newly deployed token:
3338

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
39+
![image](https://user-images.githubusercontent.com/69639595/211585859-063177cb-0cb5-40ef-8aec-0b2f9e824630.png)
3540

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

0 commit comments

Comments
 (0)