Skip to content

Fixed invalid markdown syntax usage in README.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed invalid markdown syntax usage in README.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Designed specifically for API authentication it makes supporting multiple login
Each social network eg. `Twitter, Facebook` is known as a service. A user can have multiple services.
Each service is identified by a `method` which can either be `Authenticated` (The user has used this service to authenticate and login with) or `Connected` (Which associates that service and allows importing of contacts and api access).

####Supported Social Networks
#### Supported Social Networks
- Facebook: https://github.com/nov/fb_graph2
- Twitter: https://github.com/sferik/twitter
- Google+: https://github.com/seejohnrun/google_plus

###Install
### Install
```
gem 'social_auth'
```
Expand All @@ -30,7 +30,7 @@ Type | Token | Notes
`google_plus`| `{auth_token: "token"}`| *We exchange your auth_token for a refresh_token which we do store*
`twitter`| `{access_token: "token", access_token_secret: "secret_token"}`

###Usage
### Usage
**Authenticating**

```ruby
Expand Down Expand Up @@ -100,7 +100,7 @@ class User
end
```

##Friends and Associated Services
## Friends and Associated Services

As each Service has their own set of `friends` we've created an easy way to access all your friends across each service. `acts_as_social_user` gives our `user` access to the following methods
- `friends_that_use_the_app` (returns a collection of users)
Expand All @@ -125,14 +125,14 @@ How I've gone about this is created the concept of `related_services` where by w
**Exception handling inside friends_that_use_the_app:**
If for any reason the `token` stored on the service becomes invalidated and the user attempts to make an external friends request we will catch that exception and mark that service for disconnection (which means notifying the user and destroying that service). *Note** the service will only be destroyed if its a `Connected` service, if it's an `Authenticated` service we rethrow the exception.

###Running specs
### Running specs

```ruby
BUNDLE_GEMFILE=gemfiles/rails42.gemfile bundle install
BUNDLE_GEMFILE=gemfiles/rails42.gemfile bundle exec rspec spec
```

###Exception handling
### Exception handling
Because were integrating a variety of different gems to save us handling every exception they can throw at us I'm catching most of them and throwing our own blanket Exception. The most commonly used one is `SocialAuth::InvalidToken` which uses the error message from the original exception as its own.

Exception | Notes
Expand Down