@edgedev/firebase 1.2.0 → 1.2.3

package/README.md

@@ -16,23 +16,80 @@ pnpm install @edgedev/firebase
 ```bash
 pnpm install @edgedev/firebase
 ```
-If installing into a Nuxt 3 project, you can make this globally avaiable by adding a file (whatever.ts) to your "composables" folder with the code below. 
+### Installing with Nuxt 3 global composables
+
+Add a file (whatever.ts) to your "composables" folder with this code:
 
 ```typescript
-import * as edgeFirebase from "@edgedev/firebase";
+import { EdgeFirebase } from "@edgedev/firebase";
+const config = {
+    apiKey: "your-apiKey",
+    authDomain: "your-authDomain",
+    projectId: "your-projectId",
+    storageBucket: "your-storageBucket",
+    messagingSenderId: "your-messagingSenderId",
+    appId: "your-appId"
+  };
+const edgeFirebase = new EdgeFirebase(config);
 export { edgeFirebase };
 ```
 
-Also if on Nuxt 3 - SSR must be disabled, update the nuxt.config.ts file:
+##### *Nuxt must be configured with SSR disabled, update the nuxt.config.ts file (if other parts of your project SSR, see Nuxt 3 plugin instuctions):
+```javascript
+export default defineNuxtConfig({ ssr: false });
+```
+
+### Installing as a plugin
+
+#### Vue 3 plugin, main.js example:
+```javascript
+import { createApp } from "vue";
+import App from "./App.vue";
+
+//edgeFirebase Plugin 
+import eFb from "@edgedev/firebase";
+app.use(eFb, {
+    apiKey: "your-apiKey",
+    authDomain: "your-authDomain",
+    projectId: "your-projectId",
+    storageBucket: "your-storageBucket",
+    messagingSenderId: "your-messagingSenderId",
+    appId: "your-appId"
+  })
+//end edgeFirebase
+
+app.mount("#app");
+```
+
+#### Nuxt 3 example using the plugins folder:
+Add a file (whatever.client.ts) to your "plugins" folder with the following code:
+
+***-Note the ".client" in the file name. If the file doesn't have that in the name you must disabled SSR in the nuxt config.***
+```javascript
+import eFb from "@edgedev/firebase";
+export default defineNuxtPlugin((nuxtApp) => {
+  nuxtApp.vueApp.use(eFb, {
+    apiKey: "your-apiKey",
+    authDomain: "your-authDomain",
+    projectId: "your-projectId",
+    storageBucket: "your-storageBucket",
+    messagingSenderId: "your-messagingSenderId",
+    appId: "your-appId"
+  });
+});
+```
+***-Alternatively you can disable SSR for your entire Nuxt project instead of naming the plugin with ".client", update the nuxt.config.ts file:***
+
 ```javascript
 export default defineNuxtConfig({ ssr: false });
 ```
 
-If not in Nuxt 3 or there is no need for it to be global, put this in your components <script setup> 
 
+#### After installing as a plugin you will need to include this in <script setup> in any component you want to use EdgeFirebase in:
 ```javascript
 <script setup>
-import * as edgeFirebase from "@edgedev/firebase";
+import { inject } from "vue";
+const edgeFirebase = inject("edgeFirebase");
 </script>
 ```
 # Firebase Authentication

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@edgedev/firebase",
-  "version": "1.2.0",
-  "description": "Composables and stores for firebase",
+  "version": "1.2.3",
+  "description": "Vue 3 / Nuxt 3 Plugin or Nuxt 3 global composable for firebase authenication and firestore",
   "main": "index.ts",
   "author": "Seth Fischer",
+  "keywords": [
+    "firebase",
+    "nuxt 3",
+    "vue 3"
+  ],
   "license": "ISC",
   "publishConfig": {
     "access": "public"
@@ -14,17 +19,14 @@
     "@typescript-eslint/parser": "^5.40.0",
     "eslint": "^8.25.0",
     "eslint-config-prettier": "^8.5.0",
+    "firebase": "^9.12.1",
     "prettier": "^2.7.1",
     "typescript": "^4.8.4",
-    "vite": "^3.1.8",
-    "vue": "^3.2.41",
-    "firebase": "^9.12.1"
+    "vue": "^3.2.41"
   },
-  "dependencies": {},
   "peerDependencies": {
     "firebase": "^9.12.1",
-    "vue": "^3.0.0",
-    "vite": "^3.1.8"
+    "vue": "^3.0.0"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"