strife 0.0.1 → 0.0.2

data/README.md

@@ -23,7 +23,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Strife was designed to be similar to GitHub's Octokit.rb.
+
+Strife provides methods for each of Riot's existing API calls (for
+the most recent version of each call).  To use Strife, you'll need
+to get an API key for the Riot API.  That can be obtained from the
+[Riot Developer Website](https://developer.riotgames.com/).
+
+Strife can be configured through either environment variables or
+the `Strife::Configurable` module.
+
+### Configuring via Environment Variables
+
+The following environment variables are used by Strife for configuration (see `Strife::Default` for a full list of default configuration options):
+
+#### STRIFE_API_KEY
+
+`STRIFE_API_KEY` sets the API key used by Strife for API calls.
+
+#### STRIFE_API_ENDPOINT
+
+`STRIFE_API_ENDPOINT` defines the end point of the Riot API.  This defaults to `http://prod.api.pvp.net/api/lol/`.
+
+#### STRIFE_USER_AGENT
+
+`STRIFE_USER_AGENT` defines the user agent that is sent in the user agent header when making API requests.  This defaults to `Strife Riot API GEM v0.0.2` (`v0.0.2` will vary depending on the current version of the Strife library).
+
+#### STRIFE_DEFAULT_MEDIA_TYPE
+
+`STRIFE_DEFAULT_MEDIA_TYPE` is used in the `accept` header, and defaults to `application/json`.
+
+#### STRIFE_REGION
+
+`STRIFE_REGION` determines the League of Legends game region to query against.  It defaults to `na`.  Other options include `euw` and `eune`.
+
+### Configuring with `Strife::Configurable`
+
+The `Strife::Configurable` module can also be used to configure the Strife library at run-time.  It can be used as follows:
+
+```ruby
+Strife.configure do |config|
+  config.api_key = "An API Key"
+  config.region = "na"
+end
+```
+
+See [lib/strife/default.rb](lib/strife/default.rb) for a list of default options, and [lib/strife/configurable.rb](lib/strife/configurable.rb) for a list of configuration keys (see Strife::Configurable.keys).
 
 ## Contributing
 

data/lib/strife/version.rb

@@ -1,3 +1,3 @@
 module Strife
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/strife.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["anthony.white.j@gmail.com"]
   spec.description   = %q{Strife is a ruby wrapper for the Riot API. This product is not endorsed, certified or otherwise approved in any way by Riot Games, Inc. or any of its affiliates.}
   spec.summary       = %q{Strife is a ruby wrapper for the Riot API  This product is not endorsed, certified or otherwise approved in any way by Riot Games, Inc. or any of its affiliates.}
-  spec.homepage      = ""
+  spec.homepage      = "http://www.github.com/wanthony/strife"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strife
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -167,7 +167,7 @@ files:
 - lib/strife/response/raise_error.rb
 - lib/strife/version.rb
 - strife.gemspec
-homepage: ''
+homepage: http://www.github.com/wanthony/strife
 licenses:
 - MIT
 post_install_message: 
@@ -180,12 +180,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -631594240063064478
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -631594240063064478
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23