commit 8330fa308b97d3b9f14908e46aa2686370f6cf58 Author: Sean Callan Date: Tue Nov 17 19:34:26 2015 -0800 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9607671 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/_build +/deps +erl_crash.dump +*.ez diff --git a/README.md b/README.md new file mode 100644 index 0000000..97785cb --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Überauth Twitter + +> Twitter strategy for Überauth. + +### Setup + +Include the provider in your configuration for Überauth: + +```elixir +config :ueberauth, Ueberauth, + providers: [ + twitter: [ { Ueberauth.Strategy.Twitter, [] } ] + ] +``` + +Then configure your provider: + +```elixir +config :ueberauth, Ueberauth.Strategy.Twitter.OAuth, + client_id: System.get_env("TWITTER_API_KEY"), + client_secret: System.get_env("TWITTER_API_SECRET") +``` + +For an example implementation see the [Überauth Example](https://github.com/doomspork/ueberauth_example) application. + +## Installation + +If [available in Hex](https://hex.pm/docs/publish), the package can be installed as: + +1. Add `:ueberauth_twitter` to your list of dependencies in `mix.exs`: + + ```elixir + def deps do + [{:ueberauth_twitter, "~> 0.1.0"}] + end + ```