Skip to content

Commit

Permalink
docs(readme): grammar and spelling fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
koriroys committed Mar 24, 2016
1 parent 2c5a804 commit 2f524a6
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 26 deletions.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Join the [flexi](https://embercommunity.slack.com/messages/flexi/) channel on Sl

With flexi, you can separate your markup into layouts, one for each breakpoint name
defined in `config/flexi.js`.

Given the following breakpoint names: `mobile`, `tablet`, `desktop`.

**Example:**
Expand Down Expand Up @@ -170,7 +170,7 @@ the width of the viewport.

### Container

Container is an Ember component which set's its class depending on it's current width and your defined
Container is an Ember component which sets it's class depending on it's current width and your defined
breakpoint prefixes. There are two forms of containers, `<container>` and `<grid responsive>`.

The container class will be of the form:
Expand Down Expand Up @@ -209,7 +209,7 @@ common layout situations.

### Layout Components

Layout components allow you to utilize container based breakpoints
Layout components allow you to use container based breakpoints
instead of @media queries.

```hbs
Expand All @@ -226,8 +226,8 @@ With flexi, you can build grids with or without rows. Rows are convenient
for item height resets with flexbox. Columns respond to @media breakpoints,
but they can also respond to the container they are in.

What css is included, columns, column classes, gutters, and breakpoints are
[fully configurable](#config)
You can choose which css, columns, column classes, gutters, and breakpoints
to include. It's [fully configurable](#config)

**Without rows**
```hbs
Expand Down Expand Up @@ -264,7 +264,7 @@ Flexi adds a layout service to your app.

**app/services/device/layout**

This service contains your breakpoints as well as booleans which
This service contains your breakpoints, as well as booleans which
indicate when a given breakpoint is active.

This service also contains two booleans that can be used for orientation
Expand Down Expand Up @@ -366,28 +366,28 @@ The default blueprint will install `config/flexi.js` with the [default settings]
```js
{
// the number of columns for the grid
columns: 12,
columns: 12,

// optional, used for column classes: `${colPrefix}-${breakpointPrefix}-${columnNumber}`
columnPrefix: 'col',

// if false, @media css is not included
includeMediaCSS: true,
includeMediaCSS: true,

// if false, default element styles are not included
includeElementCSS: true,

// if true, will convert layout attributes on non-layout elements to classes as well
transformAllElementLayoutAttributes: false,

// grid and layout element gutters
gutterPadding: '.5rem',

// if false, no styles are included (trumps `includeMediaCSS` and `includeElementCSS`)
includeCSS: true,

// an array of breakpoints to use in your app (see below)
breakpoints: []
breakpoints: []
}
```

Expand Down Expand Up @@ -453,26 +453,26 @@ The following responsive utilities are made available for each prefix:
- Use [Angular Style Commits](https://github.com/angular/angular.js/blob/v1.4.8/CONTRIBUTING.md#commit)
- PR against `develop` (default branch).

### Commmits
### Commmits

Angular Style commit messages have the full form:

```cli
<type>(<scope>): <title>
<body>
<footer>
```

But the abbreviated form (below) is acceptable and often preferred.

```cli
<type>(<scope>): <title>
```

Examples:

- chore(deps): bump deps in package.json and bower.json
- docs(component): document the `fast-action` component

Expand Down
2 changes: 1 addition & 1 deletion tests/dummy/app/routes/docs/layout-elements/template.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@

<h4>&lt;container&gt;&lt;/container&gt;</h4>
<p>
Container is actually an Ember component which set's it's tagName to 'container'.
Container is actually an Ember component which sets it's tagName to 'container'.
As an element, it is a relatively positioned flex box with 100% width, with no
flex property, which will display it's content vertically.
</p>
Expand Down
4 changes: 2 additions & 2 deletions tests/dummy/app/routes/docs/layout-service/template.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
{
orientation, // 'portrait' or 'landscape'
deviceIsLandscape, // boolean
deviceIsPortrait, // boolean
orientationIsLandscape, // boolean
orientationIsPortrait, // boolean
height, // number (pixels)
width, // number
Expand Down

0 comments on commit 2f524a6

Please sign in to comment.