From b5339569c7527b6707f9abfcb9ab0b3d2f8bff70 Mon Sep 17 00:00:00 2001 From: fantasticit Date: Sun, 20 Feb 2022 19:55:38 +0800 Subject: [PATCH] doc: update README --- packages/client/README.md | 35 ++--------------------------------- packages/config/README.md | 3 +++ packages/server/README.md | 2 ++ packages/share/README.md | 3 +++ 4 files changed, 10 insertions(+), 33 deletions(-) create mode 100644 packages/config/README.md create mode 100644 packages/share/README.md diff --git a/packages/client/README.md b/packages/client/README.md index c87e042..b5d08bd 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -1,34 +1,3 @@ -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). +# @think/client -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. - -[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`. - -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. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -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. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +> 客户端。 diff --git a/packages/config/README.md b/packages/config/README.md new file mode 100644 index 0000000..eaabb58 --- /dev/null +++ b/packages/config/README.md @@ -0,0 +1,3 @@ +# @think/config + +> 配置管理。 diff --git a/packages/server/README.md b/packages/server/README.md index cf896d1..19f5c71 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -1 +1,3 @@ # @think/server + +> 服务端。 diff --git a/packages/share/README.md b/packages/share/README.md new file mode 100644 index 0000000..103418f --- /dev/null +++ b/packages/share/README.md @@ -0,0 +1,3 @@ +# @think/share + +> 数据类型定义、枚举、配置等。