Formatting

Author: agentphantom

README.md

@@ -1,8 +1,8 @@
 # Firebase in ActionScript
 
-Firebase is a back end platform that offers several services to aid in the development of software, especially the ones that rely on server side infraestructure.
+Firebase is a back end platform that offers several services to aid in the development of apps and games, specially the ones that rely on server side infrastructure.
 
-Some of its services can be accesed by using RESTful techniques. This repository contains detailed guides and examples explaining how to use those services in your `Adobe AIR ` projects.
+Some of its services can be accessed by using RESTful techniques. This repository contains detailed guides and [examples](./examples) explaining how to use those services in your `Adobe AIR ` projects.
 
 You won't need an `ANE` for these guides, all of them work only using `StageWebView`, `URLRequest` and `URLLoader`.
 
@@ -13,7 +13,7 @@ This service allows you to securely authenticate users into your app. It uses Go
 
 * Leverages the use of OAuth, saving time and effort.
 * Authenticate with `Facebook`, `Google`, `Twitter`, `Email`, `Anonymous` and more.
-* Generates a `tokenId` that can be used for secure operations against Firebase Storage and Firebase Database.
+* Generates an `idToken` that can be used for secure operations against Firebase Storage and Firebase Database.
 
 ## Firebase Database
 *Main guide: [Firebase Database](./database)*
@@ -29,7 +29,7 @@ This service allows you to save and retrieve text based data. Some of its key fe
 ## Firebase Storage
 *Main guide: [Firebase Storage](./storage)*
 
-This service allows you to upload and maintain all kinds of files, including images, sounds, videos and binaries. It uses Google Cloud Messaging to provide this service. Some of its key features are:
+This service allows you to upload and maintain all kinds of files, including images, sounds, videos and binaries. It uses Google Cloud Storage to provide this service. Some of its key features are:
 
 * Securely save, retrieve and delete files using rules and Firebase Auth.
 * Load end edit metadata from files.
@@ -54,7 +54,7 @@ You can read the guides in any order but it is recommended to start with the [Fi
 
 Firebase ANEs are based on the Android and iOS official SDKs, providing all of their native features.
 
-These guides are based on the JavaScript SDK, keeping the same functionality inside the AIR runtime instead of a web browser.
+These guides are based on the JavaScript SDK, while keeping the same functionality inside the AIR runtime instead of a web browser.
 
 ### **Which are the benefits of using these guides?**
 

auth/README.md

@@ -192,7 +192,7 @@ This information is formatted the same for all providers, the most important val
 Name | Description
 ---|---
 `localId`| A unique id assigned for the logged in user for your specific Firebase project. This is very useful when working with Firebase Database and Firebase Storage.
-`idToken`| An Auth token used to access protected data and files from Firebase Database and Firebase Storage. For more information you can read the Firebase Database and Firebase Storage guides.
+`idToken`| An Authentication token that is used to identify the current logged in user. The `idToken` is heavily used in all Firebase features.
 `displayName`| The logged in user full name (Google and Facebook) or their handler in Twitter.
 `photoUrl`| The logged in user avatar.
 `email`| The logged in user email address.
@@ -201,7 +201,7 @@ Note that not all providers return the same information, for example Twitter doe
 
 Once you have the profile information you might want to save it on an Object that can be globally accessed, you will need it when performing Auth requests against Firebase Database and Firebase Storage.
 
-The `idToken` you receive from this response doesn't work with `auth` requests. You must exchange it for a new one using the next method.
+The `idToken` you receive from this response doesn't work with Firebase Database and Firebase Storage requests. You must exchange it for a new one using the next method. It still works for further Firebase Auth requests.
 
 ## Refreshing the idToken
 
@@ -254,5 +254,5 @@ A successful response will look like the following JSON structure:
 }
 ```
 
-Once you have got the `access_token` you are ready to continue performing secure operations against the Firebase Database and Firebase Storage.
+Once you have got the `access_token` you are ready to perform secure operations against the Firebase Database and Firebase Storage services.
 

auth/email/README.md

@@ -78,7 +78,7 @@ The user will be automatically registered in the Auth section from your Firebase
 
 For an Anonymous approach you don't need to specify anything in the request body. You will still get a response similar to the above just without an Email Address.
 
-The `idToken` received from this response does work for `auth` requests.
+The `idToken` received from this response does work for the Firebase Database, Firebase Storage and Firebase Auth requests.
 
 ## Verifying Credentials (Sign In)
 
@@ -125,7 +125,8 @@ A successful response will look like the following JSON structure:
 
 Note that failing to enter the correct password 3 times in a row will block the IP for future login attempts for a while.
 
-The `idToken` received from this response doesn't work for `auth` requests. You must refresh the `idToken` to get a functional one (see bottom of this guide).
+The `idToken` received from this response doesn't work for Firebase Databasae and Firebase Storage requests. You must refresh the `idToken` to get a functional one (see bottom of this guide).
+It does still work for Firebase Auth requests. 
 
 ## Password Reset
 
@@ -435,4 +436,6 @@ A successful response will look like the following JSON structure:
     "user_id": "ZJ7ud0CEpHYPF6QFWRGTe1U1Gvy2",
     "project_id": "545203846422"
 }
-```
+```
+
+Once you have got the `access_token` you are ready to perform secure operations against the Firebase Database and Firebase Storage services.

examples/README.md

@@ -8,7 +8,7 @@ It is strongly recommended to use recent versions of `Adobe AIR` and `Apache Fle
 
 An Apache Flex example that demonstrates how to use the Firebase Database with realtime data and Email auth. This project makes use of the `Responses.as` file that can be found in the [utils folder](./../utils).
 
-You will require to enable the `Email` provider for your project, you will also require the following rules in your project:
+You will require to enable the `Email` provider for your project, you will also require the following Database rules in your project:
 
 ```json
 {
@@ -23,7 +23,7 @@ You will require to enable the `Email` provider for your project, you will also
 
 ## SimpleCRUD.mxml
 
-An Apache Flex example that demonstrates how to use the Firebase Database with non realtime data. You only require the following rules in your project:
+An Apache Flex example that demonstrates how to use the Firebase Database with non realtime data. You only require the following Database rules in your project:
 
 ```json
 {

examples/SimpleChat.mxml

@@ -98,7 +98,7 @@
 			}
 			
 			/*
-			Refresh token Block
+			Refresh Token Block
 			*/			
 			private function refreshToken(idToken:String):void
 			{
@@ -202,7 +202,7 @@
 			}
 			
 			/*
-			Send Message block
+			Send Message Block
 			*/			
 			private function sendMessage():void
 			{
@@ -227,7 +227,6 @@
 			
 			private function messageSent(event:flash.events.Event):void
 			{
-				trace(event.currentTarget.data);
 				messageInput.text = "";
 			}
 									

storage/README.md

@@ -2,11 +2,11 @@
 
 Firebase Storage is based on Google Cloud Storage, a very easy and flexible solution for storing all kinds of files.
 
-Files are stored the same way as in your personal computer, using a tree hierarchy. This means there's a root folder, which can contain more folders and those folders can contain additional folders and files.
+Files are stored the same way as in your personal computer, using a tree hierarchy. This means there's a root folder which can contain more folders and those folders can contain additional folders and files.
 
 It is strongly recommended to avoid the use of special characters when naming files and folders.
 
-You need to have specific care for the slash character `(/)`. I recommend using this helper function to URL encode them:
+You need special care for the slash character `(/)`. I recommend using this helper function to URL encode them:
 
 ```actionscript
 private function formatUrl(url:String):String
@@ -19,7 +19,7 @@ In the context of this guide a `bucket` is a synonymous to your Firebase project
 
 ## Firebase Rules
 
-The Firebase Rules are a flexible way to set permissions on who can access certain data.
+The Firebase Rules are a flexible way to set permissions on who can access certain files and data.
 
 By default all the data is private and can only be accessed by Authenticated users.
 
@@ -72,7 +72,7 @@ service firebase.storage {
 }
 ```
 
-These rules will allow anyone to read the contents of a folder named `public`.
+The following rules will allow anyone to read but not to write the contents of a folder named `public`.
 
 ```
 service firebase.storage {
@@ -88,7 +88,7 @@ service firebase.storage {
 
 To upload a file you require to send it as a `ByteArray`. The following snippets show the most common scenarios.
 
-All of the following examples use the following `Event.COMPLETE` and `IOErrorEvent.IOERROR` listeners.
+All of the examples use the following `Event.COMPLETE` and `IOErrorEvent.IOERROR` listeners.
 
 ```actionscript
 private function uploadComplete(event:flash.events.Event):void
@@ -152,7 +152,7 @@ A successful response will look like the following JSON structure:
 }
 ```
 
-Your new file and `savegames` folder will instantly appear in the Storage section from the Firebase console.
+Your new file and a `savegames` folder will instantly appear in the Storage section from the Firebase console.
 
 The download link for this specific file would be:
 
@@ -162,7 +162,7 @@ The metadata link for this specific file would be:
 
 `https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/savegames%2Fsavegame.data`
 
-Notice that you need to provide the `?alt=media` parameter in order to download the actual file.
+Note that you need to provide the `?alt=media` parameter in order to download the actual file.
 
 You will also need to replace all the `/` for `%2F` after the bucket name. Otherwise it will return an error.
 
@@ -343,7 +343,7 @@ service firebase.storage {
 }
 ```
 
-The following snippet requires that you already have an `idToken` and a `localId`. You can obtain those after a successful Log In or Sign Up. For more information you can read the [Firebase Auth guide](./../auth).
+The following snippet requires that you already have a valid `idToken` and a `localId`. You can obtain those after a successful `Refresh Token` request. For more information you can read the [Firebase Auth guide](./../auth).
 
 ```actionscript
 private function uploadPersonalFile(idToken:String, localId:String):void
@@ -358,7 +358,7 @@ private function uploadPersonalFile(idToken:String, localId:String):void
 				
     var header:URLRequestHeader = new URLRequestHeader("Authorization", "Bearer "+idToken);			
 				
-    var request:URLRequest = new URLRequest(FIREBASE_STORAGE_URL+"savegames%2F"+localId+"%2Fsavegame.data");
+    var request:URLRequest = new URLRequest("https://firebasestorage.googleapis.com/v0/b/<YOUR-PROJECT-ID>.appspot.com/o/"+"savegames%2F"+localId+"%2Fsavegame.data");
     request.method = URLRequestMethod.POST;
     request.data = bytes;
     request.contentType = "text/plain";