chore: readme

Signed-off-by: ZTL-UwU <zhangtianli2006@163.com>

README.md

@@ -1,75 +1,61 @@
-# Nuxt 3 Minimal Starter
+<p align="center">
+  <a href="https://guide.the1068.pictures/" target="_blank" rel="noopener noreferrer">
+    <img width="500" src="https://github.com/SMS-COSMO/the1068guide/assets/49156174/d8841777-5784-4db9-b306-bbcc4cc5cf88" alt="the1068guide logo">
+  </a>
+</p>
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+<p align="center">
+A guidebook for SMS freshmen.
+</p>
 
-## Setup
+<p align="center">
+  <a href="https://hub.nuxt.com"><img src="https://img.shields.io/badge/Built%20With%20NuxtHub-18181B?logo=nuxt.js" alt="NuxtHub Website"></a>
+  <a href="https://github.com/SMS-COSMO/the1068guide/pulls"><img src="https://img.shields.io/badge/PRs-welcome-blue.svg" alt="PRs Welcome"></a>
+  <a href="https://stats.uptimerobot.com/AGNLNIrGM6"><img src="https://img.shields.io/uptimerobot/ratio/m797091495-a3ff7259d931a7c6d5420ed7" alt="Uptime"></a>
+</p>
 
-Make sure to install the dependencies:
+## Usage
 
-```bash
-# npm
-npm install
+### As an end user
+✅ Just visit [the website](https://guide.the1068.pictures/) to use!
 
-# pnpm
-pnpm install
+### As an admin
+🔐 Login to [the dashboard](https://guide.the1068.pictures/admin).
 
-# yarn
-yarn install
+## Stack
 
-# bun
-bun install
-```
+- [Nuxt Hub](https://hub.nuxt.com/) - Build, deploy & manage
+Nuxt apps, globally.
+- [shadcn-vue](https://www.shadcn-vue.com/) - Re-usable components built with Radix Vue, and Tailwind CSS. An unofficial, community-led Vue port of shadcn/ui.
+- [tRPC.io](https://trpc.io/) - End-to-end typesafe APIs made easy.
+- [Drizzle ORM](https://orm.drizzle.team/) - Next Generation TypeScript ORM
 
-## Development Server
+## Contributing
 
-Start the development server on `http://localhost:3000`:
+### Local Setup
 
-```bash
-# npm
-npm run dev
+Clone the repository and run on the root folder:
 
-# pnpm
+```
+pnpm i
 pnpm run dev
-
-# yarn
-yarn dev
-
-# bun
-bun run dev
 ```
 
-## Production
-
-Build the application for production:
+#### Scripts available:
 
-```bash
-# npm
-npm run build
+Run the scrips with `pnpm run xxx`.
 
-# pnpm
-pnpm run build
+1. `dev`: Start dev server
+2. `build`: Build for production
+3. `lint`: Lint code
+4. `lint:fix`: Lint code with auto fixing
 
-# yarn
-yarn build
+## Contributors
 
-# bun
-bun run build
-```
+<a href="https://github.com/sms-cosmo/the1068guide/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=sms-cosmo/the1068guide" />
+</a>
 
-Locally preview production build:
-
-```bash
-# npm
-npm run preview
-
-# pnpm
-pnpm run preview
-
-# yarn
-yarn preview
-
-# bun
-bun run preview
-```
+## License
 
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+[GPL v3](./LICENSE) &copy; 2024 the1068guide contributors