docs: add package readme (#107)

webfansplz · web-flow · commit 40e8c6a9b4f6 · 2023-12-29T16:07:53.000+08:00
diff --git a/docs/guide/contributing.md b/docs/guide/contributing.md
@@ -2,26 +2,41 @@
 
 > Hi! We're really excited that you're interested in contributing to Vue DevTools! Before submitting your contribution, please read through the following guide.
 
-## Monorepo
+## Development Setup
 
-The Vue DevTools repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/).
-After cloning the repo, run in the root folder.
+You will need [Node.js](https://nodejs.org) **version 18.12+**, and [PNPM](https://pnpm.io) **version 8+**.
 
-```sh
-pnpm i
+We also recommend installing [@antfu/ni](https://github.com/antfu/ni) to help switching between repos using different package managers. `ni` also provides the handy `nr` command which running npm scripts easier.
+
+After cloning the repo, run:
+
+```bash
+$ pnpm i # install the dependencies of the project
 ```
 
-## Development
+## Git Hooks
+
+The project uses [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) to enforce the following on each commit:
+
+- Automatically format changed files using ESLint
 
-### Setup
+## Development
 
-Build the project by
+Build the project with watch mode:
 
 ```sh
 pnpm dev
 ```
 
-And then run the playground
+OR
+
+Build the project with:
+
+```sh
+pnpm build
+```
+
+And then run the playground:
 
 ```sh
 pnpm play
diff --git a/packages/browser-extension/README.md b/packages/browser-extension/README.md
@@ -0,0 +1,3 @@
+# Browser extension
+
+> DevTools Browser extension, coming soon...
diff --git a/packages/client/README.md b/packages/client/README.md
@@ -0,0 +1,3 @@
+# DevTools Client
+
+> Client for DevTools.
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -0,0 +1,3 @@
+# @vue/devtools-core
+
+> Internal core functions shared across @vue/devtools packages.
diff --git a/packages/devtools-api/README.md b/packages/devtools-api/README.md
@@ -0,0 +1,7 @@
+# @vue/devtools-api
+
+> Plugins API for easier DevTools integrations.
+
+## Getting Started
+
+Please follow the documentation at [devtools-next.vuejs.org](https://devtools-next.vuejs.org/plugins/api).
diff --git a/packages/devtools-kit/README.md b/packages/devtools-kit/README.md
@@ -0,0 +1,3 @@
+# @vue/devtools-kit
+
+> Utility kit for DevTools.
diff --git a/packages/devtools/README.md b/packages/devtools/README.md
@@ -0,0 +1,7 @@
+# @vue/devtools
+
+> This package provides a standalone vue-devtools application, that can be used to debug any Vue app regardless of the environment. Now you can debug your app opened in mobile browser, safari, native script etc. not just desktop chrome or firefox.
+
+## Getting Started
+
+Please follow the documentation at [devtools-next.vuejs.org](https://devtools-next.vuejs.org/guide/standalone).
diff --git a/packages/electron/README.md b/packages/electron/README.md
@@ -0,0 +1,3 @@
+# Electron
+
+> DevTools Electron App, used in [@vue/devtools](../devtools/README.md).
diff --git a/packages/schema/README.md b/packages/schema/README.md
@@ -0,0 +1,3 @@
+# @vue/devtools-ui
+
+> UI kit for DevTools.
diff --git a/packages/shared/README.md b/packages/shared/README.md
@@ -0,0 +1,3 @@
+# @vue/devtools-shared
+
+> Internal utility types shared across @vue/devtools packages.
diff --git a/packages/ui/README.md b/packages/ui/README.md
@@ -0,0 +1,3 @@
+# @vue/devtools-ui
+
+> UI kit for DevTools.
diff --git a/packages/vite/README.md b/packages/vite/README.md
@@ -0,0 +1,31 @@
+# vite-plugin-vue-devtools
+
+> `vite-plugin-vue-devtools` is a `Vite` plugin designed to enhance the `Vue` developer experience.
+
+## Installation
+
+```sh
+
+npm add -D vite-plugin-vue-devtools
+
+```
+
+## Usage
+
+### Configuration Vite
+
+```ts
+import { defineConfig } from 'vite'
+import VueDevTools from 'vite-plugin-vue-devtools'
+
+export default defineConfig({
+  plugins: [
+    VueDevTools(),
+    vue(),
+  ],
+})
+```
+
+## Documentation
+
+Check out all the DevTools details at [devtools-next.vuejs.org](https://devtools-next.vuejs.org).

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Browser extension`
	`2`	`+`
	`3`	`+> DevTools Browser extension, coming soon...`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# DevTools Client`
	`2`	`+`
	`3`	`+> Client for DevTools.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# @vue/devtools-core`
	`2`	`+`
	`3`	`+> Internal core functions shared across @vue/devtools packages.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# @vue/devtools-kit`
	`2`	`+`
	`3`	`+> Utility kit for DevTools.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Electron`
	`2`	`+`
	`3`	`+> DevTools Electron App, used in [@vue/devtools](../devtools/README.md).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# @vue/devtools-ui`
	`2`	`+`
	`3`	`+> UI kit for DevTools.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# @vue/devtools-shared`
	`2`	`+`
	`3`	`+> Internal utility types shared across @vue/devtools packages.`