From f473e7f2613f3b5941457a923f8cd7b9d6c4eed9 Mon Sep 17 00:00:00 2001
From: Sidney Alcantara <sidney@sidney.me>
Date: Tue, 25 Aug 2020 19:01:16 +1000
Subject: [PATCH] update set up instructions

---
 README.md     | 53 +++++++++++++++++++++++++++++++++++++++++++--------
 cli/README.md | 42 +++++++++++++++++++++++-----------------
 2 files changed, 69 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index da774559..09eb57fb 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Cloud.
 
 ![Commit](https://img.shields.io/github/last-commit/AntlerVC/firetable?color=%23ed4747)
 
-[![Discord Shield](https://discordapp.com/api/guilds/746329234720686132/widget.png?style=shield)](https://discord.gg/Vdshr9E)
+<!-- [![Discord Shield](https://discordapp.com/api/guilds/746329234720686132/widget.png?style=shield)](https://discord.gg/Vdshr9E) -->
 
 ### Firetable UI
 
@@ -19,8 +19,10 @@ supported. More coming soon, for comprehensive list see ROADMAP.md.
 
 ## Setup instructions
 
-### 1. Create a Firebase project [(Instructions)](https://console.firebase.google.com/u/0/)
+### 1. Create and set up a Firebase project
 
+- Create a new project using the
+  [Firebase Console](https://console.firebase.google.com/)
 - Create a Firestore database
 - Set up Firestore Security Rules: use Test Mode or set up required permissions.
 
@@ -38,18 +40,53 @@ supported. More coming soon, for comprehensive list see ROADMAP.md.
   }
   ```
 
-  [Or follow this guide for setting up you rules](RULES.md)
+  [Or follow this guide for setting up custom rules](RULES.md)
 
 - Upgrade project to the Blaze Plan
 - Enable the Google sign-in method in **Authentication / Sign-in method**
 
-### 2. Clone this repo
+### 2. Run the Firetable CLI
+
+The Firetable CLI automates the steps required to set up your Firetable app
+locally.
+
+Before using it, make sure you have the Firebase CLI installed.
+[Instructions](https://firebase.google.com/docs/cli)
+
+```
+npm install -g firetable
+```
+
+or
+
+```
+yarn global add firetable
+```
+
+Then run the following command, specifying the directory for your Firetable app.
+
+```
+firetable init [directory]
+```
+
+Now you can run Firetable locally using
+
+```
+cd [directory]
+firetable start
+```
+
+### 3. Manually set up Firetable app
+
+If you don’t want to run the Firetable CLI, follow these steps:
+
+#### 1. Clone this repo
 
 ```
 git clone https://github.com/AntlerVC/firetable.git
 ```
 
-### 3. Set React app environment variables
+#### 2. Set React app environment variables
 
 Create a .env file in the `www` directory
 
@@ -57,7 +94,7 @@ Create a .env file in the `www` directory
   Project’s **Settings** page. Click the cog icon on the left sidebar (under the
   Firebase logo) and click **Project settings**
 
-- (optional) Get the generated **Application ID** and **Search-Only API Key**
+- (Optional) Get the generated **Application ID** and **Search-Only API Key**
   from the Algolia **API Keys** page
 
 ```
@@ -67,14 +104,14 @@ REACT_APP_ALGOLIA_APP_ID=
 REACT_APP_ALGOLIA_SEARCH_API_KEY=
 ```
 
-### 4. Install front-end dependencies
+#### 3. Install front-end dependencies
 
 ```
 cd www
 yarn
 ```
 
-### 5. Run project locally
+#### 4. Run project locally
 
 ```
 yarn start
diff --git a/cli/README.md b/cli/README.md
index c7d3748c..8fd4a5c8 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -1,42 +1,48 @@
 # Firetable CLI
 
-## Prerequisites
+## Installation requirements
 
-please insure you have the following installed;
-[Git](https://git-scm.com/downloads), [Node](https://nodejs.org/en/download/),
-[Yarn](https://classic.yarnpkg.com/en/docs/install/)
+Make sure you have the following installed:
 
-### Firebase
+- [Git](https://git-scm.com/downloads)
+- [Node](https://nodejs.org/en/download/)
+- [Firebase CLI](https://firebase.google.com/docs/cli)
 
-insure that you have [firebase-tools](https://firebase.google.com/docs/cli) and
-logged in to your firebase account.
+Also make sure you are logged in to your Firebase account in the Firebase CLI.
 
 ## Installation
 
 ```
-npm install -g firetable@latest
+npm install -g firetable
 ```
 
-## Setup
-
-set directory you want to setup firetable in then run
+or
 
 ```
-firetable init
+yarn global add firetable
 ```
 
-### run Locally
+## Commands
+
+### Create a new project
+
+```
+firetable init [directory]
+```
+
+### Run firetable locally
+
+Before you run locally, make sure you have a Firebase project set up.
+[Instructions](https://github.com/AntlerVC/firetable#setup-instructions)
 
 ```
 firetable start
 ```
 
-### deploying to firebase hosting
+### Deploy to Firebase Hosting
 
-insure that you have created a site on your projects
-[firebase hosting](https://console.firebase.google.com/u/0/project/_/hosting)
-
-then run
+First, make sure that you have created a site in your Firebase project.
+[Open Firebase console](https://console.firebase.google.com/)
 
 ```
 firetable deploy