Skip to content

Commit

Permalink
updated installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoow committed Jun 25, 2014
1 parent 9eb0b0d commit 73dede4
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 133 deletions.
44 changes: 10 additions & 34 deletions packages/ember-simple-auth-cookie-store/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,9 @@ based session store__. It offers the same functionality as the standard
`localStorage` based store but __also supports older browsers__ that don't
support the `locaStorage` API.

## Using the Cookie Store
## Configuration

To use the cookie store, simply require its autoloader:

```js
require('simple-auth-cookie-store/ember');
```

which sets up an
[initializer](http://emberjs.com/api/classes/Ember.Application.html#toc_initializers)
named `'simple-auth-cookie-store'`, and configure it in the global environment
object:
The Cookie Store can be configured via the global environment object:

```js
window.ENV = window.ENV || {};
Expand All @@ -33,31 +24,16 @@ To install Ember Simple Auth Cookie Store in an Ember.js application there are
several options:

* If you're using [Ember CLI](https://github.com/stefanpenner/ember-cli), just
add Ember Simple Auth to the `bower.json` file:
add the
[Ember CLI Addon](https://github.com/simplabs/ember-cli-simple-auth-cookie-store)
to your project
* The Ember Simple Auth Cookie Store extenion library is also included in the
_"ember-simple-auth"_ bower package both in a browserified version as well as
an AMD build. If you're using the AMD build from bower be sure to require the
autoloader:

```js
{
"dependencies": {
"simple-auth": "https://github.com/simplabs/ember-simple-auth-component.git"
}
}
```

and import the library to the `Brocfile.js`:

```js
app.import('vendor/ember-simple-auth/amd/simple-auth-cookie-store.amd.js', {
// whitelist all modules you want to use, e.g.
//
// 'simple-auth/stores/cookie': ['default']
});
```

* The bower component also includes a browserified version that can simply be
loaded in the Ember.js application:

```html
<script src="vendor/ember-simple-auth/simple-auth-cookie-store.js"></script>
require('simple-auth-cookie-store/ember');
```

* Download a prebuilt version from
Expand Down
43 changes: 8 additions & 35 deletions packages/ember-simple-auth-devise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,18 +119,6 @@ invalidates the session__ as the Rails session cookie will still be present
because Ember Simple Auth does not know anything about that cookie and will not
delete it on session invalidation!

## Client Side Setup

To enable the Devise extension library, simply import its autoloader:

```js
require('simple-auth-devise/ember');
```

which sets up an
[initializer](http://emberjs.com/api/classes/Ember.Application.html#toc_initializers)
named `'simple-auth-devise'`.

## The Authenticator

In order to use the Devise authenticator (see the
Expand Down Expand Up @@ -198,31 +186,16 @@ To install Ember Simple Auth Devise in an Ember.js application there are
several options:

* If you're using [Ember CLI](https://github.com/stefanpenner/ember-cli), just
add Ember Simple Auth to the `bower.json` file:
add the
[Ember CLI Addon](https://github.com/simplabs/ember-cli-simple-auth-devise)
to your project
* The Ember Simple Auth Devise extenion library is also included in the
_"ember-simple-auth"_ bower package both in a browserified version as well as
an AMD build. If you're using the AMD build from bower be sure to require the
autoloader:

```js
{
"dependencies": {
"simple-auth": "https://github.com/simplabs/ember-simple-auth-component.git"
}
}
```

and import the library to the `Brocfile.js`:

```js
app.import('vendor/ember-simple-auth/amd/simple-auth-devise.amd.js', {
// whitelist all modules you want to use, e.g.
//
// 'simple-auth/authorizers/devise': ['default']
});
```

* The bower component also includes a browserified version that can simply be
loaded in the Ember.js application:

```html
<script src="vendor/ember-simple-auth/simple-auth-devise.js"></script>
require('simple-auth-devise/ember');
```

* Download a prebuilt version from
Expand Down
43 changes: 8 additions & 35 deletions packages/ember-simple-auth-oauth2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,6 @@ __[The API docs for Ember Simple Auth OAuth 2.0 are available here](http://ember
This is an extension to the Ember Simple Auth library that provides an
authenticator and an authorizer that are compatible with OAuth 2.0.

## Enabling Ember Simple Auth OAuth 2.0

To enable the OAuth 2.0 extension library, simply require its autoloader:

```js
require('simple-auth-oauth2/ember');
```

which sets up an
[initializer](http://emberjs.com/api/classes/Ember.Application.html#toc_initializers)
named `'simple-auth-oauth2'`;

## The Authenticator

The authenticator (see the
Expand Down Expand Up @@ -146,31 +134,16 @@ To install Ember Simple Auth OAuth 2.0 in an Ember.js application there are
several options:

* If you're using [Ember CLI](https://github.com/stefanpenner/ember-cli), just
add Ember Simple Auth to the `bower.json` file:
add the
[Ember CLI Addon](https://github.com/simplabs/ember-cli-simple-auth-oauth2)
to your project
* The Ember Simple Auth OAuth 2.0 extenion library is also included in the
_"ember-simple-auth"_ bower package both in a browserified version as well as
an AMD build. If you're using the AMD build from bower be sure to require the
autoloader:

```js
{
"dependencies": {
"simple-auth": "https://github.com/simplabs/ember-simple-auth-component.git"
}
}
```

and import the library to the `Brocfile.js`:

```js
app.import('vendor/ember-simple-auth/amd/simple-auth-oauth2.amd.js', {
// whitelist all modules you want to use, e.g.
//
// 'simple-auth/authorizers/oauth2': ['default']
});
```

* The bower component also includes a browserified version that can simply be
loaded in the Ember.js application:

```html
<script src="vendor/ember-simple-auth/simple-auth-oauth2.js"></script>
require('simple-auth-oauth2/ember');
```

* Download a prebuilt version from
Expand Down
38 changes: 9 additions & 29 deletions packages/ember-simple-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,42 +306,22 @@ the examples.
To install Ember Simple Auth in an Ember.js application there are several options:

* If you're using [Ember CLI](https://github.com/stefanpenner/ember-cli), just
add Ember Simple Auth to the `bower.json` file:
add one of the Ember CLI Addons to your project:
* https://github.com/simplabs/ember-cli-simple-auth
* https://github.com/simplabs/ember-cli-simple-auth-oauth2
* https://github.com/simplabs/ember-cli-simple-auth-devise
* https://github.com/simplabs/ember-cli-simple-auth-cookie-store
* Ember Simple Auth is also available in the _"ember-simple-auth"_ bower
package which includes both a browserified version as well as an AMD build.
If you're using the AMD build from bower be sure to require the autoloader:

```js
{
"dependencies": {
"ember-simple-auth": *
}
}
```

and import the library to the `Brocfile.js`:

```js
app.import('vendor/ember-simple-auth/simple-auth.amd.js', {
// whitelist all modules you want to use, e.g.
//
// 'simple-auth/authorizers/base': ['default']
});
```

* The bower component also includes a browserified version that can simply be
loaded in the Ember.js application:

```html
<script src="vendor/ember-simple-auth/simple-auth.js"></script>
require('simple-auth/ember');
```

* Download a prebuilt version from
[the releases page](https://github.com/simplabs/ember-simple-auth/releases)
* [Build it yourself](#building)
* If you're using Ruby on Rails, you can add the (unofficial) source gem that
supports the Ruby on Rails asset pipeline by adding it to your `Gemfile`:
```ruby
gem 'ember_simple_auth-rails'
```

## Building

Expand Down

0 comments on commit 73dede4

Please sign in to comment.