Merge pull request #5 from Imtiyaz-CHOUJAI/master

Fix issues with docs

Author: amranidev

docs/authentication.md

@@ -2,17 +2,17 @@
 !!! tip 
     It's recommended to take a look at the firebase authentication docs, please check the following link[firebase auth docs](https://firebase.google.com/docs/auth/web/start).
 
-How hard it is to integrate **Firebase auth** to your web project especially when you try to structure and organize firebase auth globally to be used through all **Vue components**.
+How hard it is to integrate **Firebase auth** to your web project especially when you try to structure and organize firebase auth globally to be used through all your **Vue components**.
 
-Thanks to **Myfirebase auth system** which makes firebase auth easier to be managed using **Vuex**, the fireabse auth is injected and triggered at beginning of the Vue instance.
+Thanks to **Myfirebase auth system** it makes firebase auth easier to be managed using **Vuex**, its injected and triggered at beginning of the Vue instance.
 
 <hr>
 
 #### Auth instance
 
 Syntax : `$auth`
 
-`$auth` is a global auth instance which called through Vue component.
+`$auth` is a global auth instance which is called through the Vue component.
 
 ##### Example
 
@@ -84,7 +84,7 @@ Syntax : `$auth.getUser()`
 You can update profile avatar usign `updateProfilePicture(object)` method, this will update the default firebase user **profileURL**.
 
 !!! tip
-    Before you start updating profile picture, make sure that you have uploaded that picture to firebase storage, and get photoURL, see [Upload a file with Myfirebase]().
+    Before you start updating profile pictures, make sure that you have uploaded that picture to firebase storage, and got photoURL, see [Upload a file with Myfirebase]().
 
 Syntax : `$auth.updateProfilePicture(String)`
 Return : `Promise`
@@ -121,7 +121,7 @@ Return : `Promise`
 Syntax : `$auth.state(String, String)`
 Return : `Promise`
 
-Consider it just like an auth middleware where you can check if the user is signed in or not, you can also redirect the user to another component if he doesn't sign in.
+Consider it just like an auth middleware where you can check if the user is signed in or not, you can also redirect the user to another component if he is not signed in.
 
 ##### Example
 
@@ -202,7 +202,7 @@ Return : `Promise`
 
 #### Signup with email and password
 
-To register a new user with email and password.
+To register a new user with an email and password.
 
 Synax : `$auth.registerWithEmailAndPassword()`
 Return : `Promise`
@@ -252,7 +252,7 @@ Return : `Promise`
 
 #### SignIn with email and password
 
-To sign in a user with email and passowrd.
+To sign in a user with an email and passowrd.
 
 Syntax : `$auth.loginWithEmailAndPassword(String, String)`
 Return : `Promise`
@@ -304,7 +304,7 @@ Return : `Promise`
 
 #### SignIn with google
 
-Allow the users to authenticate to Firebase using their **Google accounts**.
+Allow users to authenticate to Firebase using their **Google accounts**.
 
 Syntax : `$auth.signInWithGoogle()`
 Return : `Promise`
@@ -353,7 +353,7 @@ Return : `Promise`
 
 #### SignIn with Facebook
 
-Allow the users to authenticate to Firebase using their **Facebook Accounts**.
+Allow users to authenticate to Firebase using their **Facebook Accounts**.
 
 Syntax : `$auth.signInWithFacebook()`
 Return : `Promise`
@@ -362,7 +362,7 @@ Return : `Promise`
 
 #### SignIn with Twitter
 
-Allow the users to authenticate to Firebase using their **Twitter Accounts**.
+Allow users to authenticate to Firebase using their **Twitter Accounts**.
 
 Syntax : `$auth.signInWithTwitter()`
 Return : `Promise`
@@ -371,7 +371,7 @@ Return : `Promise`
 
 #### SignIn with Github
 
-Allow the users to authenticate to Firebase using their **Github Accounts**.
+Allow users to authenticate to Firebase using their **Github Accounts**.
 
 Syntax : `$auth.signInWithGithub()`
 Return : `Promise`

docs/cloud-functions.md

@@ -60,4 +60,4 @@ exports.sendMessageNotification = functions.database.ref('data/{messageID}').onW
 As you can see it's easy to write functions with firebase cloud functions.
 
 !!! info "Firebase cloud messaging" 
-    This example of sending push notification requires registering a service-worker through client site (browser) which is already defined in this project, check the following link [Cloud Messaging](cloud-messaging.md).
+    This example of sending push notification requires registering a service-worker through the client site (browser) which is already defined in this project, check the following link [Cloud Messaging](cloud-messaging.md).

docs/cloud-messaging.md

@@ -40,6 +40,4 @@ messaging.setBackgroundMessageHandler(function(payload) {
 
 ```
 
-This service worker will handle notification messages even in the background when the user is not opening the browser.
-
-To send a notification message to a client you could write your logic through a single firebase cloud function, we already have an example, check the following link [Cloud functions](cloud-functions.md).
+This service worker will handle notification messages even in the background when the users browser is not opened the .

docs/components.md

@@ -1,10 +1,10 @@
-At the high level, components are custom elements that Vue compiler would attach specified behavior too. They contain your HTML, scripts, and stylesheets at the same time in one file.
+A little advanced, components are custom elements that Vue compiler would attach specified behaviors too. They contain your HTML, scripts, and stylesheets at the same time all in one file.
 
 They are located in the `/src/components/` directory.
 
-To create a new component you could run `new:component command` in your terminal.
+To create a new component you need to run `new:component command` in your terminal.
 
-`myfirebase new:component <component-name>`, the Myfirebase-CLI will generate a new component and put it inside your application `/src/components/<component-name>.vue`.
+`myfirebase new:component <component-name>`, the Myfirebase-CLI will generate a new component and place it inside your components directory `/src/components/<component-name>.vue`.
 
 A simple component might look something like this:
 

docs/directory-structure.md

@@ -1,4 +1,4 @@
-By default, Myfirebase application structure provides a great starting point for your application. However, you are free to organize your files/directories as you like.
+By default, Myfirebases structure provides a great starting point for your application. However, you are free to organize your files/directories as you like.
 
 #### Root Directory
 
@@ -27,18 +27,18 @@ For sure, you are free to define and organize this directory structure however y
 !!! tip "Firebase Cloud functions docs"
     New to firebase?, please see [Firebase Cloud functions docs](https://firebase.google.com/docs/functions/).
 
-Firebase cloud functions directory, where the cloud functions are located, in this directory you could write some back-end functions to handle cloud messaging and business logic if necessary and a lot of advanced stuff.
+In the firebase cloud functions directory,you can write some back-end functions to handle cloud messaging and business logic if necessary and a lot of advanced stuff.
 
 !!! tip "Google Cloud Platform"
-    It's become easier to integrate some advanced kinds of stuff such as machine learning and image processing with [Google Cloud Platform](https://cloud.google.com).
+    It's become easier to integrate some advanced technologies such as machine learning and image processing with [Google Cloud Platform](https://cloud.google.com) and more.
 
 #### `/storage`
 
 The storage directory contains all of your storage files, using one of Vuejs eco-system, see [Vuex](https://vuex.vuejs.org/en/).
 
 #### `/public`
 
-Public directory contains the main index.html file, this directory also houses all of your application compiled assets CSS, JS files and service-workers as well, **these assets will be auto injected to index.html**
+The public directory contains the main index.html file, it also houses all of your applications compiled assets CSS, JS files and service-workers, **these assets will be auto injected to index.html**
 
 !!! note "service workers"
     Google developers had made some cool articles about the service-worker concept, see [Service Workers: an Introduction](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers).
@@ -59,16 +59,16 @@ Public directory contains the main index.html file, this directory also houses a
 
 #### `/build`
 
-Apparently, you may not touch anything right here, this directory contains all the **build** files managed by node.js unless you want to specify some of your additional configuration such as development server port, service-workers or even changing web pack configuration.
+Apparently, you may not want to touch anything right here, this directory contains all the **build** files managed by node.js unless you want to specify some of your additional configuration such as development server port, service-workers or even changing web pack configuration, then you may proceed.
 
 #### `/config`
 
 Where the development and the production mode configuration are located.
 
 #### `/static`
 
-Where static files are located, images and icons are used as a static assets into your applications.
+Where static files are located, images and icons are used as a static assets in your applications.
 
 #### `/tests`
 
-Where your application tests are located, by default Myfirebase comes with eslint and karma for unit testing, you are free to integrate others libraries and plugins such as [night watch](http://nightwatchjs.org/) e2e.
+Where your application tests are located, by default Myfirebase comes with eslint and karma for unit testing, you are free to integrate other libraries and plugins such as [night watch](http://nightwatchjs.org/) e2e.

docs/global-guard.md

@@ -1,5 +1,5 @@
 
-As the name implies, the navigation guards provided by vue-router are primarily used to guard navigations either by redirecting it or canceling it. There are a number of ways to hook into the route navigation process: globally, per-route, or in-component.
+As the name implies, the navigation guards provided by vue-router are primarily used to guard navigation either by redirecting it or canceling it. There are a number of ways to hook into the route navigation process: globally, per-route, or in-component.
 
 !!! warning
     Remember that params or query changes won't trigger enter/leave navigation guards. You can either watch the $route object to react to those changes or use the beforeRouteUpdate in-component guard, see [vue-router global navigation guards](https://router.vuejs.org/en/advanced/navigation-guards.html).
@@ -8,7 +8,7 @@ As the name implies, the navigation guards provided by vue-router are primarily
 
 #### Creating middleware
 
-Myfirebase provides a simple way to create navigations guards or middlewares, you could simply run `myfirebase new:middleware <middleware-name>`. Myfirebase-cli will generate a middleware template for you located in `/src/middlewares/` directory.
+Myfirebase provides a simple way to create navigations guards or middlewares, you could simply run `myfirebase new:middleware <middleware-name>`. Myfirebase-cli will generate a middleware template for you located in the `/src/middlewares/` directory.
 
 Typically, The middleware generated might look something like this:
 
@@ -56,7 +56,7 @@ export default middlewares
 
 #### Auth Middleware
 
-Myfirebase comes with an example called AuthMiddleware located in middlewares directory, this will check if the user is signed-in or not, and be redirecting users to the login page.
+Myfirebase comes with an example called AuthMiddleware located in middlewares directory, this will check if the user is signed-in or not, and redirect users to the login page.
 
 As you may notice, you will find in the **route.js** file a **metadata** called auth, which is assigned to **App** and **UpdateProfile** components.
 

docs/index.md

@@ -5,7 +5,7 @@
 <h3 align="center"><b>Myfirebase</b> <i>SPA Framework</i> Documentation</h3>
 
 !!! info
-	Welcome to Myfirebase docs, in this guide, we assume that you already familiar with [VueJs framework ecosystem](http://vuejs.org), [webpack](https://webpack.github.io/), [Firebase](https://firebase.google.com) and [node package manager](https://www.npmjs.com/).
+	Welcome to Myfirebase docs, in this guide, we assume that you are already familiar with [VueJs framework ecosystem](http://vuejs.org), [webpack](https://webpack.github.io/), [Firebase](https://firebase.google.com) and [node package manager](https://www.npmjs.com/).
 
 **Myfirebase** Is a decoupled single page application framework which is highly compatible with [Google Firebase](https://firebase.google.com). It has some really cool features.
 

docs/installation.md

@@ -1,8 +1,8 @@
 #### Prerequisites
 
-1. **NPM** is the recommended installation method when building large-scaled applications with **Myfirebase**.
+1. **NPM** is the recommended installation method when building large-scale applications with **Myfirebase**.
 
-    If this is the first time you want to give **npm** a shot, don't worry, we got exactly what you need.
+    If this is the first time you are trying **npm** , don't worry, we'll guide you every step of the way.
 
     - [How to Install Node.js and NPM on Windows](http://blog.teamtreehouse.com/install-node-js-npm-windows)
 
@@ -16,7 +16,7 @@
 
 #### Installing Myfirebase
 
-- Create new Myfirebase project via myfirebase-cli. 
+- Create a new Myfirebase project via myfirebase-cli. 
 
 ```shell
 # Create new project with myfirebase-cli

docs/routing.md

@@ -7,17 +7,17 @@ Myfirebase is using Vuejs routes system, all routes are located in `/src/routes/
 
 By default, Myfirebase has some default routes already defined in `routes.js` file.
 
-- Layout.vue: which is the default layout of our application.
+- Layout.vue: which is the default layout of the application.
 
-- Welcome.vue: which is a default welcoming component.
+- Welcome.vue: which is a default welcome component.
 
 - Login.vue: which is responsible for authenticating users (register/login/logout) using firebase authentication.
 
 - UpdateProfile.vue: which is responsible for updating user profile (email/password) and user avatar using firebase cloud storage.
 
-- App.vue: which is the default component to start playing with the firebase database.
+- App.vue: which is the default component to manipulate the firebase database.
 
-- Firestore.vue: which is the default component to start playing with the cloud firestore.
+- Firestore.vue: which is the default component to use the cloud firestore.
 
 ```javascript
 

docs/storage.md

@@ -7,7 +7,7 @@ Myfirebase provides a simple way to interact with firebase storage via a global
 
 Syntax : `$storage`
 
-`$auth` is a global auth instance which called through Vue component.
+`$auth` is a global auth instance which called through the Vue component.
 
 <hr>
 
@@ -23,7 +23,7 @@ You can retrieve firebase storage object using `get()` method.
 
 Syntax : `$storage.getDownloadURL(object)`
 
-You can get your file URL of the user avatar or document which stored through firebase storage using `getDownloadURL`.
+You can get the file URL of the user avatar or document which stored through firebase storage using `getDownloadURL`.
 
 ##### Example
 
@@ -152,4 +152,4 @@ You can delete a file with `delete` method specifying the file path.
         }
     }
 </script>
-```
+``` 

docs/store.md

@@ -1,4 +1,4 @@
-Myfirebase is using Vuex which is a simple scalable state management system compatible with Vuejs, all Myfirebase states are located in `/storage` directory.
+Myfirebase is using Vuex which is a simple scalable state management system compatible with Vuejs, all of Myfirebase states are located in `/storage` directory.
 
 Storage directory houses `store.js`, `myfirebase-auth` and `myfirebase-storage`.