jekyll_github_sample 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e15fe8ebc87794c54e191923c1b9de31f3625f3f
-  data.tar.gz: 63f7e2b7fdcf92b69b93d27977f60705da18d500
+  metadata.gz: 5585bb2ea60e1388df57d874f086433b379a1aee
+  data.tar.gz: 9673372519de8950efe55069e0e891a2238b5865
 SHA512:
-  metadata.gz: 2a2e8c914656e384509428f445dbe201fe38120223fd56d4dc9f24b5e3d0159d51a5b8bf0a7597cfeee40de40787dfe466baaf357f8a3e5336c543f2d1647734
-  data.tar.gz: 717a53467bdd19f5e302896a532f74d671af26c5a740c6202a0c81c0d1bcb4becf5cc46b6db2dc31f0319b6519118df299130e56d8f03eaba0c5e53fa370a4cd
+  metadata.gz: 6b32f27b4fb16cb00ea9255d41ceee949b88cfc79ac564b4fc939b7589d8439c1641d1989301d9eec61af4abaab6ea32b25fc0126f283b1e714fff5e258dca9b
+  data.tar.gz: dbf67abb90d396482697b641a14818e16b3579c987351e63c338b9ee4a8e1193043eace9592c83c1f02c5a7d5551d23bee503ed7535075d34d47f50b3796a2c1

data/README.md

@@ -5,7 +5,17 @@ Two Jekyll Liquid tags to display a code sample from a file in a public Github r
 
 # Install
 
-Add the github_sample_tag.rb file to your Jekyll project _plugins directory.
+- First add the gem to your `Gemfile` 
+```
+gem 'jekyll_github_sample'
+```
+- `bundle` to install the gem
+- Add the gem to your Jekyll `_config.yml`
+
+```
+gems: [jekyll_github_sample]
+```
+- Startup or relaunch Jekyll
 
 # Live Examples
 
@@ -13,19 +23,19 @@ A [write up](https://bwillis.github.io/2014/05/28/include-github-repo-code-in-je
 
 # github_sample Usage
 ```
-github_sample URL_WITH_USERNAME_REPO_AND_FILE <START_LINE_NUMBER> <END_LINE_NUMBER>
+{% github_sample URL_WITH_USERNAME_REPO_AND_FILE <START_LINE_NUMBER> <END_LINE_NUMBER> %}
 ```
 
- * URL_WITH_USERNAME_REPO_AND_FILE - the full path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs
+ * URL_WITH_USERNAME_REPO_AND_FILE - the relative path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs. A url to this README would be: `bwillis/jekyll-github-sample/blob/a3bc9e82412d364aa76e9308ab53ff2bddaa2faf/README.md`
  * START_LINE_NUMBER - (optional) number that is the first line to include (0 based)
  * END_LINE_NUMBER - (optional) number that is the last line to include, if excluded will read to end of file
 
-# github_reference Usage
+# github_sample_ref Usage
 ```
 {% github_sample_ref URL_WITH_USERNAME_REPO_AND_FILE %}
 ```
 
- * URL_WITH_USERNAME_REPO_AND_FILE - the full path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs
+ * URL_WITH_USERNAME_REPO_AND_FILE - the relative path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs. A url to this README would be: `bwillis/jekyll-github-sample/blob/a3bc9e82412d364aa76e9308ab53ff2bddaa2faf/README.md`
 
 # Example Usage
 
@@ -37,3 +47,12 @@ This is how you would display, reference and highlight code in your Jekyll post.
 {% github_sample /bwillis/versioncake/989237901cb873f96df12be48cbf1239be496bd7/Appraisals 0 5 %}
 {% endhighlight %}
 ```
+
+# Thanks!
+
+Thanks to all those who have helped make this really awesome:
+
+* [heedfull](https://github.com/heedfull)
+
+# License
+Jekyll Github Sample is released under the MIT license: www.opensource.org/licenses/MIT

data/jekyll_github_sample.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.authors     = ['Ben Willis']
   s.email       = ['benjamin.willis@gmail.com']
-  s.homepage    = 'http://bwillis.github.io/jekyll-github-sample'
+  s.homepage    = 'https://github.com/bwillis/jekyll-github-sample'
   s.summary     = %q{Include a sample of a Github repo file.}
   s.description = %q{Easily reference and include a Github repo file in your post.}
 
@@ -17,10 +17,10 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'activesupport', '~> 4.0'
-  s.add_dependency 'jekyll',        '~> 1.0'
+  s.add_dependency 'jekyll',        '~> 2.0'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
 
-end
+end

data/lib/jekyll_github_sample/version.rb

@@ -1,3 +1,3 @@
 module JekyllGithubSample
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_github_sample
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben Willis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +102,7 @@ files:
 - spec/lib/jekyll_github_sample/file_helper_spec.rb
 - spec/lib/jekyll_github_sample/text_utils_spec.rb
 - spec/spec_helper.rb
-homepage: http://bwillis.github.io/jekyll-github-sample
+homepage: https://github.com/bwillis/jekyll-github-sample
 licenses:
 - MIT
 metadata: {}