docs(*):add tags, update readme

guocaoyi · Jul 6, 2022 · dd6974b · dd6974b
1 parent ffb5646
commit dd6974b
Show file tree

Hide file tree

Showing 10 changed files with 70 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -31,4 +31,4 @@ import inferno from 'vite-plugin-inferno'
 export default defineConfig({
   plugins: [inferno()],
 })
-```
+```
diff --git a/packages/vite-inferno-js/package.json b/packages/vite-inferno-js/package.json
@@ -1,14 +1,18 @@
 {
   "name": "vite-inferno-js-starter",
   "version": "0.0.0",
-  "description": "",
+  "description": "Vite + Inferno + JS",
   "author": "yalda",
   "license": "MIT",
   "type": "module",
   "keywords": [
     "vite",
     "inferno",
-    "vite-boilerplate"
+    "infernojs",
+    "vite-boilerplate",
+    "vite-starter",
+    "vite-template",
+    "inferno-boilerplate"
   ],
   "scripts": {
     "dev": "vite",
@@ -19,7 +23,7 @@
     "inferno": "^8.0.1"
   },
   "devDependencies": {
-    "vite-plugin-inferno": "0.0.1",
+    "vite-plugin-inferno": "0.0.0",
     "vite": "^2.9.13"
   }
 }
diff --git a/packages/vite-inferno-js/src/App.jsx b/packages/vite-inferno-js/src/App.jsx
@@ -14,7 +14,7 @@ class App extends Component {
           </a>
           <p>{`Welcome to Inferno ${version}`}</p>
           <p>
-            Edit <code>src/App.js</code> and save to reload.!
+            Edit <code>src/App.jsx</code> and save to reload.!
           </p>
         </header>
       </div>

diff --git a/packages/vite-inferno-js/src/index.css b/packages/vite-inferno-js/src/index.css
@@ -1,14 +1,12 @@
 body {
   margin: 0;
   padding: 0;
-  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
-    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
-    sans-serif;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu',
+    'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
   -webkit-font-smoothing: antialiased;
   -moz-osx-font-smoothing: grayscale;
 }
 
 code {
-  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
-    monospace;
+  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', monospace;
 }
diff --git a/packages/vite-inferno-ts/package.json b/packages/vite-inferno-ts/package.json
@@ -1,14 +1,17 @@
 {
   "name": "vite-inferno-ts-starter",
   "version": "0.0.0",
-  "description": "",
+  "description": "Vite + Inferno + TS",
   "author": "yalda",
   "license": "MIT",
   "type": "module",
   "keywords": [
     "vite",
     "inferno",
-    "vite-boilerplate"
+    "vite-boilerplate",
+    "vite-starter",
+    "vite-template",
+    "inferno-boilerplate"
   ],
   "scripts": {
     "dev": "vite",
@@ -19,7 +22,7 @@
     "inferno": "^8.0.1"
   },
   "devDependencies": {
-    "vite-plugin-inferno": "0.0.1",
+    "vite-plugin-inferno": "0.0.0",
     "typescript": "^4.6.4",
     "vite": "^2.9.13"
   }

diff --git a/packages/vite-inferno-ts/src/App.tsx b/packages/vite-inferno-ts/src/App.tsx
@@ -14,7 +14,7 @@ class App extends Component {
           </a>
           <p>{`Welcome to Inferno ${version}`}</p>
           <p>
-            Edit <code>src/App.js</code> and save to reload.!
+            Edit <code>src/App.tsx</code> and save to reload.!
           </p>
         </header>
       </div>

diff --git a/packages/vite-inferno-ts/src/index.css b/packages/vite-inferno-ts/src/index.css
@@ -1,14 +1,12 @@
 body {
   margin: 0;
   padding: 0;
-  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
-    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
-    sans-serif;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu',
+    'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
   -webkit-font-smoothing: antialiased;
   -moz-osx-font-smoothing: grayscale;
 }
 
 code {
-  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
-    monospace;
+  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', monospace;
 }
diff --git a/packages/vite-plugin-inferno/README.md b/packages/vite-plugin-inferno/README.md
@@ -0,0 +1,34 @@
+# vite-plugin-inferno
+
+An all in one preset for writing Inferno apps with the vite bundler.
+
+## Features
+
+- 🚀 Hot Module Replacement via prefresh
+- 🔨 Devtools bridge during development
+
+## Installing
+
+```bash
+λ npm i vite-plugin-inferno --save-dev
+
+# or with pnpm
+λ pnpm install vite-plugin-inferno --save-dev
+
+# or with yarn
+yarn add vite-plugin-inferno -D
+```
+
+## Usage
+
+configurate in `vite.config.ts` or `vite.config.js`
+
+```typescript
+import { defineConfig } from 'vite'
+import inferno from 'vite-plugin-inferno'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [inferno()],
+})
+```
diff --git a/packages/vite-plugin-inferno/package.json b/packages/vite-plugin-inferno/package.json
@@ -1,13 +1,14 @@
 {
   "name": "vite-plugin-inferno",
-  "version": "0.0.1",
+  "version": "0.0.0",
   "description": "inferno preset for the vite bundler",
   "author": "yalda",
   "license": "MIT",
   "keywords": [
     "vite",
     "vite-preset",
     "vite-plugin",
+    "vite-plugin-inferno",
     "inferno"
   ],
   "main": "./cjs/index.js",
@@ -25,6 +26,14 @@
     "esm",
     "types"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guocaoyi/vite-plugin-inferno.git"
+  },
+  "bugs": {
+    "url": "https://github.com/guocaoyi/vite-plugin-inferno/issues"
+  },
+  "homepage": "https://github.com/guocaoyi/vite-plugin-inferno",
   "scripts": {
     "build": "rimraf cjs esm types && tsc && tsc -p tsconfig.cjs.json && node scripts/build.mjs",
     "prepublishOnly": "npm run build"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,4 +31,4 @@ import inferno from 'vite-plugin-inferno' @@
     export default defineConfig({
       plugins: [inferno()],
     })
-    ```
+    ```