Merge branch 'release/v1.0.5'

klich3 · Jul 23, 2024 · ea803d7 · ea803d7
2 parents bbfd78c + 2f131d7
commit ea803d7
Show file tree

Hide file tree

Showing 9 changed files with 4,794 additions and 13 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -13,7 +13,7 @@ authors:
     family-names: Sychev
     affiliation: too
 repository-code: "https://github.com/klich3/credits-log"
-abstract: Rollup plugin to add credits message on debug console
+abstract: Rollup plugin to add credits message on user browser debug console.
 keywords:
   - npm
   - rollup
@@ -22,5 +22,10 @@ keywords:
   - cli
   - contributors
   - humans
+  - credits
+  - log
+  - console
+  - vite
+  - frontend
 license: MIT
-version: 1.0.4
+version: 1.0.5
diff --git a/README.md b/README.md
@@ -42,6 +42,27 @@ export default defineConfig({
 });
 ```
 
+## Extension
+
+Now there is a new parameter to implement: `frontEnd: true`, that when placed in front end pressing the `F1` key will show a floating window with Credits of the project.
+
+```javascript
+//vite.config.json
+import creditslog from "credits-log"
+
+export default defineConfig({
+    ...
+    plugins: [
+		    ...
+        creditslog({
+          frontEnd: true
+        })
+        ...
+    ],
+    ...
+});
+```
+
 ---
 
 ## Parameteres in `package.json`

diff --git a/_test_project_commonjs/vite.config.js b/_test_project_commonjs/vite.config.js
@@ -46,5 +46,7 @@ module.exports = defineConfig({
 			},
 		],
 	},
-	plugins: [creditslog()],
+	plugins: [creditslog({
+		frontEnd: true
+	})],
 });