Skip to content

Commit

Permalink
update(readme): typos
Browse files Browse the repository at this point in the history
Closes angular#32. Closes angular#34.
s
  • Loading branch information
ThomasBurleson committed May 26, 2015
1 parent 7ca354b commit a8c832c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Angular Material-Start

This Material **start*** project is a *seed* for AngularJS Material applications. The project contains a sample AngularJS application and is preconfigured to install the Angular framework and a bunch of development and testing tools for instant web development gratification.
This Material **start*** project is a *seed* for AngularJS Material applications. The project contains a sample AngularJS application and is pre-configured to install the Angular framework and a bunch of development and testing tools for instant web development gratification.

This sample application is intended to be useful as both a learning tool and a skeleton application
for a typical [AngularJS Material](http:https://material.angularjs.org/) web app: comprised of a Side navigation
area and a content area. You can use it to quickly bootstrap your angular webapp projects and dev
area and a content area. You can use it to quickly bootstrap your AngularJS webapp projects and dev
environment for these projects.

### What is the UX?

Below is a snaphot of the Starter-App with the Users' *master-detail* view. Also shown is the user
Below is a snapshot of the Starter-App with the Users' *master-detail* view. Also shown is the user
experience that will is displayed for smaller device sizes. The responsive layout changes to hide
the user list, reveal the **menu** button. In the User Details view, you may also click the
**share** button to show the Contact <User> bottom sheet view.
Expand Down Expand Up @@ -84,11 +84,11 @@ The `depth=1` tells git to only pull down one commit worth of historical data.

#### Install Dependencies

We have two kinds of dependencies in this project: tools and angular framework code. The tools help
We have two kinds of dependencies in this project: tools and AngularJS framework code. The tools help
us manage and test the application.

* We get the tools we depend upon via `npm`, the [node package manager][npm].
* We get the angular code via `bower`, a [client-side code package manager][bower].
* We get the AngularJS code via `bower`, a [client-side code package manager][bower].

We have preconfigured `npm` to automatically run `bower` so we can simply do:

Expand All @@ -100,11 +100,11 @@ Behind the scenes this will also call `bower install`. You should find that you
folders in your project.

* `node_modules` - contains the npm packages for the tools we need
* `app/bower_components` - contains the angular framework files
* `app/bower_components` - contains the AngularJS framework files

*Note that the `bower_components` folder would normally be installed in the root folder but
material-start changes this location through the `.bowerrc` file. Putting it in the app folder makes
it easier to serve the files by a webserver.*
it easier to serve the files by a web server.*

### Run End-to-End Tests

Expand Down Expand Up @@ -165,7 +165,7 @@ e2e-tests/ --> end-to-end tests
## Updating Angular

Previously we recommended that you merge in changes to angular-seed into your own fork of the
project. Now that the Angular framework library code and tools are acquired through package managers
project. Now that the AngularJS framework library code and tools are acquired through package managers
(npm and bower) you can use these tools instead to update the dependencies.

You can update the tool dependencies by running:
Expand All @@ -187,15 +187,15 @@ This will find the latest versions that match the version ranges specified in th

## Serving the Application Files

While angular is client-side-only technology and it's possible to create angular webapps that
While AngularJS is client-side-only technology and it's possible to create AngularJS webapps that
don't require a backend server at all, we recommend serving the project files using a local
webserver during development to avoid issues with security restrictions (sandbox) in browsers. The
web server during development to avoid issues with security restrictions (sandbox) in browsers. The
sandbox implementation varies between browsers, but quite often prevents things like cookies, xhr,
etc to function properly when an html page is opened via `file:https://` scheme instead of `http:https://`.

### Running the App during Development

The angular-seed project comes preconfigured with a local development webserver. It is a node.js
The angular-seed project comes pre-configured with a local development web server. It is a node.js
tool called [http-server][http-server]. You can install http-server globally:

```
Expand Down

0 comments on commit a8c832c

Please sign in to comment.