fastenv 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67e94392e708cc2b285d3119726e1eed616e8686
-  data.tar.gz: 44e4e5fef08f8c4642c0716286f282393df15f14
+  metadata.gz: 89d95332b8d91bbba1eb1523620932eb276e641f
+  data.tar.gz: 8517cf01810d392a8384754023b3bd3de5c330ee
 SHA512:
-  metadata.gz: ecdba5415fcef25f353950593676e110f23477f39b3d764b5acde4690ec720fe32959ee718b2571dfbdf94d4a51a17c0e38bd3f0dadf1a042eb2a9850fdb9655
-  data.tar.gz: 9010c39ca0b05282722ed4f1f5dd461732546334a4af3f7a3b7b95fa74aa5f8e830c14456e9e3efba1d919a23473b76c649650e7c96fa37f710d93568d513f84
+  metadata.gz: a1208a38f61a7a81bfef27150593da1a5f31fb2aa8a8845aa585273c1df711444550e9016a04297c96cc047a7ed14df11822c7c922edb225a50c5902a40c772e
+  data.tar.gz: 97c0d65a617a616389ceaaed40732d856534cc1965911f69ec92c2c4042fd0bfd2d2156e00b1048bcf00087f6593ed2106bfb1c245927f1ead1485228233eb59

data/LICENSE.txt

@@ -20,3 +20,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -1,6 +1,9 @@
 # Fastenv
 
-TODO: Write a gem description
+Fast access to environment variables. Takes advantage of method_missing to
+easily return values of environment variable.
+
+Why? Because TYPING_IN_ALL_CAPS isn't fun or readable.
 
 ## Installation
 
@@ -12,20 +15,68 @@ gem 'fastenv'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install fastenv
+```
+$ gem install fastenv
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Say you have an environment variable
+
+```bash
+WORDPRESS_USERNAME="La-de-da-de-da"
+```
+
+You can access it from your Ruby code as simply as
+
+```ruby
+require 'fastenv'
+
+Fastenv.wordpress_username
+```
+
+If the environment variable doesn't exist, a `NameError` will be raise.
+
+Fastenv is intended for querying credentials. Missing credentials is an
+exceptional event.
+
+---
+
+## Goes Well With
+
+Pair it with [dotenv](https://github.com/bkeepers/dotenv) to easily set _and_
+retrieve your credentials from environment variables.
+
+```bash
+# .env
+WORDPRESS_USERNAME="TweedleDee"
+WORDPRESS_PASSWORD="password"
+```
+
+```ruby
+# your_app.rb
+require 'dotenv'
+Dotenv.load
+
+require 'fastenv'
+
+credentials = {
+  username: Fastenv.wordpress_username,
+  password: Fastenv.wordpress_password }
+# => {:username=>"TweedleDee", :password=>"password"}
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/fastenv/fork )
+1. Fork it ( https://github.com/kyletolle/fastenv/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+

data/fastenv.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["kyle@nullsix.com"]
   spec.summary       = %q{Fast access to environment variables.}
   spec.description   = %q{Takes advantage of method_missing to give you fast access to environment variables.}
-  spec.homepage      = "https://rubygems.org/gems/fastenv"
+  spec.homepage      = "https://github.com/kyletolle/fastenv"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/fastenv/version.rb

@@ -1,4 +1,4 @@
 class Fastenv
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastenv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kyle Tolle
@@ -72,7 +72,7 @@ files:
 - lib/fastenv/version.rb
 - spec/fastenv_spec.rb
 - spec/spec_helper.rb
-homepage: https://rubygems.org/gems/fastenv
+homepage: https://github.com/kyletolle/fastenv
 licenses:
 - MIT
 metadata: {}