everything-core 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69e52c236a5c4804f441d36c26ae4c03891ff260
-  data.tar.gz: 9f735a1cf43a54a02bfa1aebf871e57cbfd970d6
+  metadata.gz: 5a17687cc66c5c0c99821b775eee107ab0425b27
+  data.tar.gz: 56dc019b950f486d68f68ddbf38f7e8f4218e495
 SHA512:
-  metadata.gz: fa037d2e464a0b8bd791b4efad2f9d6d9101050bbf6952020b6f16b7f500a9582daa9e4231f07bb988a22a49a3ecde661df25d27ac07411f453de8ea508f8a7d
-  data.tar.gz: 58e047a7b77a26761badc892a16ff381ae0bdb0b7976e52ce1dc2d408cd0ef758f1a34b41ca14c17ff69bc674e1a5ff8c87c2d6fd2dc29539839d3d03129f2f9
+  metadata.gz: 8681ba9e53c5bce59cb520bcb943dfd8a688d4f9cb3d3e8198ac22fd2f5aef7cc69746fd0993fc234f2f63ab97099f61bb57b082b4ed353efee6350aec0ab172
+  data.tar.gz: ffab10e88a2fcf7d2de8a680ebbc360b2acb67a8b8d19046b55bc5109f8eded6ca754fb4219da86ebed4d10059e0f69554db2f470b1a8cd95a817270d27b6836

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+.env

data/README.md

@@ -1,5 +1,8 @@
 # everything-core
 
+For familiarity with a `everything` repository, see the
+[intro](http://blog.kyletolle.com/introducing-everything/).
+
 The piece is the most important concept of everything. This is the core for
 everything, and other pieces will be components you can add into it.
 
@@ -9,11 +12,40 @@ Must define these environment variables:
 
 - `EVERYTHING_PATH` - the full path to your everything repo.
 
+## Installation
+
+```
+gem install everything-core
+```
+
 ## Usage
 
+This assumes you have a `EVERYTHING_PATH` environment variable either set in
+your shell or in dotenv's `.env` file.
+
+For example, let's assume you have the following folder and file under your
+everything path
 
 ```
-TODO: This should really be a gem that other projects can include.
+your-piece-here/index.md
+
+# Your Piece Here
+
+The rest of the content of your file...
+
+```
+
+To use the piece from IRB, you could do the following to get the piece's title
+and content.
+
+```
+require 'everything'
+
+piece_path = File.join(Everything.path, 'your-piece-here')
+piece      = Everything::Piece.new(piece_path)
+
+piece.title   # => "Your Piece Here"
+piece.content # => "The rest of the content of your file...\n\n"
 ```
 
 ## License

data/everything-core.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "fastenv", "= 0.0.2"
+  spec.add_runtime_dependency "dotenv", "= 2.0.2"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.4"

data/lib/everything/version.rb

@@ -1,3 +1,3 @@
 class Everything
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/everything.rb

@@ -1,3 +1,6 @@
+require 'dotenv'
+Dotenv.load
+
 require 'fastenv'
 require 'everything/version'
 require 'everything/piece'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: everything-core
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kyle Tolle
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement