Improve README

[joshcanhelp]

• Add more clear instructions on how to use the management API
• Add information on authentication endpoints implemented
• Add a note on state validation
• Add links to additional documentation and OmniAuth strategy
• Remove broken Gemnasium badge

Closes #102

[machuga]

Found a few things in here to revisit

[machuga]

Indentation should be 2 spaces in. This looks like it may be a tab. This may have happened when I copied the example to you from a shoddy copy out of my terminal :)

[machuga]

Was there a reason you didn't go with the memoized API we chatted about being idiomatic Rails?

class AllUsersController < ApplicationController
  # Get all users from Auth0 with "auth0" in their email.
  def index
   @params = {
     q: "email:*auth0*",
     fields: 'email,user_id,name',
     include_fields: true,
     page: 0,
     per_page: 50
   }
   @users = auth0.users @params
  end

  private

  # Setup the Auth0 API connection.
  def auth0
   @auth0 ||= Auth0Client.new(
     client_id: ENV['AUTH0_RUBY_CLIENT_ID'],
     token: ENV['AUTH0_RUBY_API_TOKEN'],
     domain: ENV['AUTH0_RUBY_DOMAIN'],
     api_version: 2,
     timeout: 15 # optional, defaults to 10s
   )
  end
end

This will allow a user to reference auth0 method as many times as they want without having to establish a new connection or concern themselves with setting it up in a before_action.

[machuga]

Consider linking to Issues tab.

[joshcanhelp]

@machuga

RE: Whitespace ... I'm using a MD editor and tab is just tab there (as opposed to my editor that converts to spaces) so probably my fault :) fixed!

RE: Memoization ... I see what you're doing there now. I think I was still doing memoization but using a before_action instead of a method. Fixed!

RE: Issues tab ... added!

[machuga]

Can remove before_action portion of this since it's inaccurate.

[machuga]

Can drop this whitespace

[machuga]

A helper function would need to be declared at the base class level I believe in order to be shared to the view. This function would need declared at a base class level to be shared across controllers. We may not want to provide this suggestion as helper functions are a bit controversial in general.

[joshcanhelp]

@machuga - Fixed up! Thanks for your patience with this

[machuga]

LGTM!