Skip to content
This repository was archived by the owner on Oct 19, 2018. It is now read-only.

Commit a912635

Browse files
committed
updated README
1 parent f1a97c5 commit a912635

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Hyperloop TodoMVC Tutorial
22

3-
In this tutorial you will build the classic TodoMVC application using Hyperloop
3+
In this tutorial you will build the classic [TodoMVC](http://todomvc.com) application using Hyperloop
44
![](todo-chapter-1.png?raw=true)
55

66
The finished application will
@@ -15,7 +15,7 @@ You will write less than 100 lines of code, and the tutorial should take about 1
1515

1616
### Chapter 1: Setting Things Up
1717

18-
If you do not already have Ruby, Rails, and bundler setup on your development machine then the easiest way to get started doing full stack development with Hyperloop is to use [Cloud9](http://c9.io).
18+
If you do not already have Git, Ruby, Rails, and bundler setup on your development machine then the easiest way to get started doing full stack development with Hyperloop is to use [Cloud9](http://c9.io).
1919

2020
Even if you are an experienced Rails developer there are some advantages to doing your first experiments on Cloud 9:
2121

@@ -25,7 +25,7 @@ Even if you are an experienced Rails developer there are some advantages to doin
2525

2626
Once you are comfortable with Hyperloop, transitioning your app back to your normal development environment is as easy as doing a git pull of your saved repo.
2727

28-
**If you want to go ahead as setup hyperloop on your development machine follow these [instructions.](https://github.com/ruby-hyperloop/rails-clone-and-go)**
28+
**If you want to go ahead and setup hyperloop on your development machine (not using Cloud9) follow these [instructions.](https://github.com/ruby-hyperloop/rails-clone-and-go)**
2929

3030
Continue for Cloud9 setup:
3131

@@ -41,15 +41,13 @@ Make sure to Connect your Cloud9 account to your github account by going to sett
4141

4242
You will be invited to create your first workspace. Cloud9 gives you one private workspace and any number of public workspaces. We recommend you use the public option for your first experiments.
4343

44-
Put `git@github.com:ruby-hyperloop/rails-clone-and-go.git` into the field titled titled Clone from Git or Mercurial URL (optional).
44+
Put "`git@github.com:ruby-hyperloop/rails-clone-and-go.git`" into the field titled **"Clone from Git or Mercurial URL"**.
4545

46-
Select the "Ruby on Rails" template type, and
46+
Select the "Ruby on Rails" template type, and click the **[Create workspace]** button.
4747

48-
Create Your Workspace!
48+
**Step 3: Choose Your Branch**
4949

50-
**Step 3: Choose Your Branch
51-
52-
The hyperloop clone and go repo has two branches: `master` and `thin`. If you are running on the default Cloud9 512MB workspace
50+
The Hyperloop clone and go repo has two branches: `master` and `thin`. If you are running on the default Cloud9 512MB workspace
5351
then you should switch the `thin` branch before proceeding. This will use a lot less resources (but will be using polling
5452
instead of ActionCable) for push communications. To checkout the `thin` branch run
5553
```bash
@@ -81,6 +79,14 @@ We are going to add our Todo Model, and discover that Hyperloop models are in fa
8179
+ Changes to models on the server are synchronized with all participating browsers.
8280
+ Data access is is protected by a robust *policy* mechanism.
8381

82+
>*What is Model? ActiveRecord models are Ruby classes that are backed by a database.
83+
Rails automatically generates the necessary SQL code for you. So when you say `Todo.active` Rails generates the appropriate SQL
84+
and turns the result of the query into appropriate Ruby data structures.*
85+
86+
87+
>*Hyperloop Models are extensions of ActiveRecord models that synchronize the data between the client and server
88+
automatically for you. So now when you say `Todo.active` it works the same whether you are executing on the server or the client.*
89+
8490
Okay lets see it in action:
8591

8692
1. **Add the Todo Model:**
@@ -881,8 +887,6 @@ Rails.application.routes.draw do
881887
end
882888
```
883889

884-
885-
886890
### General troubleshooting
887891

888892
1: Wait. On initial boot it can take several minutes to pre-compile all the system assets.

0 commit comments

Comments
 (0)