Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Started creating user guide pages

  • Loading branch information...
commit db231eb51dc952be3788095202986c8f3b771ddf 1 parent b2e2ddd
@shadowhand shadowhand authored
View
5 guide/menu.oauth.md
@@ -0,0 +1,5 @@
+1. **OAuth**
+ - [About](oauth.about)
+ - [Configuration](oauth.config)
+ - [Usage](oauth.usage)
+ - [Examples](oauth.examples)
View
14 guide/oauth.about.md
@@ -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].
+
+
View
24 guide/oauth.config.md
@@ -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.
Please sign in to comment.
Something went wrong with that request. Please try again.