Skip to content

Commit

Permalink
Started creating user guide pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Woody Gilk committed Jul 4, 2010
1 parent b2e2ddd commit db231eb
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
5 changes: 5 additions & 0 deletions guide/menu.oauth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
1. **OAuth**
- [About](oauth.about)
- [Configuration](oauth.config)
- [Usage](oauth.usage)
- [Examples](oauth.examples)
14 changes: 14 additions & 0 deletions guide/oauth.about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# About OAuth

[OAuth](http://oauth.net/) is an open protocol to allow secure API authorization in a simple and standard method from desktop and web applications. This module provides a pure PHP implementation of the OAuth v1.0 protocol, with support for PLAINTEXT and HMAC-SHA1 signatures.

## Supported Providers

The following providers are available by default:

* [Twitter](http://twitter.com/) using [OAuth_Provider_Twitter]
* [Google](http://www.google.com/) using [OAuth_Provider_Google]

Additional providers can be created by creating an extension of [OAuth_Provider].


24 changes: 24 additions & 0 deletions guide/oauth.config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# OAuth Configuration

All configuration for OAuth is done in the `config/oauth.php` file. The configuration file is organized by the provider name.

## Example Configuration File

return array(
/**
* Twitter application registration: https://twitter.com/apps
*/
'twitter' => array(
'key' => 'your consumer key',
'secret' => 'your consumer secret'
),
/**
* Google application registration: https://www.google.com/accounts/ManageDomains
*/
'google' => array(
'key' => 'your domain name',
'secret' => 'your consumer secret'
),
);

[!!] The consumer key and secret **must** be defined for all providers.

0 comments on commit db231eb

Please sign in to comment.