|
| 1 | +# Welcome to the home of Scribe, the simple OAuth Java lib! |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +### Before submitting a pull request [please read this](https://github.com/fernandezpablo85/scribe-java/wiki/Scribe-scope-revised) |
| 6 | + |
| 7 | +# Why use Scribe? |
| 8 | + |
| 9 | +### Dead Simple |
| 10 | + |
| 11 | +Who said OAuth was difficult? Configuring scribe is __so easy your grandma can do it__! check it out: |
| 12 | + |
| 13 | +```java |
| 14 | +OAuthService service = new ServiceBuilder() |
| 15 | + .provider(LinkedInApi.class) |
| 16 | + .apiKey(YOUR_API_KEY) |
| 17 | + .apiSecret(YOUR_API_SECRET) |
| 18 | + .build(); |
| 19 | +``` |
| 20 | + |
| 21 | +That **single line** (added newlines for readability) is the only thing you need to configure scribe with LinkedIn's OAuth API for example. |
| 22 | + |
| 23 | +### Threadsafe |
| 24 | + |
| 25 | +Hit Scribe as hard and with many threads as you like. |
| 26 | + |
| 27 | +### Supports all major 1.0a and 2.0 OAuth APIs out-of-the-box |
| 28 | + |
| 29 | +* Google |
| 30 | + |
| 31 | +* Facebook |
| 32 | + |
| 33 | +* Yahoo |
| 34 | + |
| 35 | +* LinkedIn |
| 36 | + |
| 37 | +* Twitter |
| 38 | + |
| 39 | +* Foursquare |
| 40 | + |
| 41 | +* Evernote |
| 42 | + |
| 43 | +* Vimeo |
| 44 | + |
| 45 | +* Yammer |
| 46 | + |
| 47 | +* Windows Live |
| 48 | + |
| 49 | +* and many more! check the "examples folder":http://github.com/fernandezpablo85/scribe-java/tree/master/src/test/java/org/scribe/examples |
| 50 | + |
| 51 | +### Small and modular |
| 52 | + |
| 53 | +Scribe's code is small (about 1k LOC) and simple to understand. No smart-ass or "clever" hacks here. |
| 54 | + |
| 55 | +### Android-Ready |
| 56 | + |
| 57 | +Works out of the box with android(TM) applications. |
| 58 | + |
| 59 | +### Stable & bulletproof |
| 60 | + |
| 61 | +Good test coverage to keep you safe from harm. |
| 62 | + |
| 63 | +When something bad actually happens, Scribe's meaningful error messages will tell you exactly what went wrong, when and where. |
| 64 | + |
| 65 | +### Pull it from Maven! |
| 66 | + |
| 67 | +You can pull scribe from my maven repository, just add these to your __pom.xml__ file: |
| 68 | + |
| 69 | +```xml |
| 70 | + |
| 71 | +<!-- repository --> |
| 72 | +<repositories> |
| 73 | + <repository> |
| 74 | + <id>scribe-java-mvn-repo</id> |
| 75 | + <url>https://raw.github.com/fernandezpablo85/scribe-java/mvn-repo/</url> |
| 76 | + <snapshots> |
| 77 | + <enabled>true</enabled> |
| 78 | + <updatePolicy>always</updatePolicy> |
| 79 | + </snapshots> |
| 80 | + </repository> |
| 81 | +</repositories> |
| 82 | + |
| 83 | +<!-- dependency --> |
| 84 | +<dependency> |
| 85 | + <groupId>org.scribe</groupId> |
| 86 | + <artifactId>scribe</artifactId> |
| 87 | + <version>1.3.5</version> |
| 88 | +</dependency> |
| 89 | +``` |
| 90 | + |
| 91 | +## Getting started in less than 2 minutes |
| 92 | + |
| 93 | +Check the [Getting Started](http://wiki.github.com/fernandezpablo85/scribe-java/getting-started) page and start rocking! Please Read the [FAQ](http://wiki.github.com/fernandezpablo85/scribe-java/faq) before creating an issue :) |
| 94 | + |
| 95 | +## Questions? |
| 96 | + |
| 97 | +Feel free to drop me an email, but there's already a [StackOverflow](http://stackoverflow.com) tag for [scribe](http://stackoverflow.com/questions/tagged/scribe) you should use. I'm subscribed to it so I'll pick the question immediately. |
| 98 | + |
| 99 | +## Forks |
| 100 | + |
| 101 | +Looking for a scribe variation? check the [Fork List](https://github.com/fernandezpablo85/scribe-java/wiki/Forks) |
| 102 | + |
| 103 | +If you have a useful fork that should be listed there please contact me (see About me). |
| 104 | + |
| 105 | +## About me |
| 106 | + |
| 107 | +[LinkedIn profile](http://www.linkedin.com/in/fernandezpablo85) |
| 108 | + |
| 109 | +Follow me: [@fernandezpablo](http://twitter.com/fernandezpablo) |
0 commit comments