Skip to content

Commit 0f02b08

Browse files
committed
Update README
1 parent 1287cf1 commit 0f02b08

File tree

1 file changed

+12
-29
lines changed

1 file changed

+12
-29
lines changed

README.md

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,17 @@
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+
<h1 align="center">
2+
<a href="https://github.com/iot-portal-device-management/web">
3+
IoT Portal Device Management Web Client
4+
</a>
5+
</h1>
26

3-
## Getting Started
7+
This repository houses the web client for IoT Portal Device Management.
48

5-
First, run the development server:
9+
## 👏 Contributing
610

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
```
11+
Thank you for considering contributing to the IoT Portal Device Management! PHPStorm is highly recommended if you are
12+
working on this project. Please commit any pull requests against the `main` branch.
1213

13-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
14+
## 📄 License
1415

15-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
16-
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`.
18-
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.
20-
21-
## Learn More
22-
23-
To learn more about Next.js, take a look at the following resources:
24-
25-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
26-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
27-
28-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
29-
30-
## Deploy on Vercel
31-
32-
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.
33-
34-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
16+
This project is open-sourced software licensed under the
17+
[GPL-2.0-or-later license](https://spdx.org/licenses/GPL-2.0-or-later.html).

0 commit comments

Comments
 (0)