readme

Author: codecalm

README.md

@@ -9,7 +9,24 @@ A Jekyll plugin that generates _pseudo-random_ data. Very useful when you want t
 
 ## Installation
 
-Simply download the `random.rb` file and place it in the `_plugins` directory of your Jekyll site.
+1. Add the following to your site's `Gemfile`:
+
+  ```ruby
+  gem 'jekyll-random'
+  ```
+
+2. Add the following to your site's `_config.yml`:
+
+  ```yml
+  plugins:
+    - jekyll-random
+  ```
+
+If you are using a Jekyll version less than `3.5.0`, use the `gems` key instead of `plugins`.
+
+### Manual installation
+
+Simply download the `lib/jekyll-random.rb` file and place it in the `_plugins` directory of your Jekyll site.
 
 
 ## Usage

jekyll-random.gemspec

@@ -1,16 +1,17 @@
 Gem::Specification.new do |s|
-  s.name = "jekyll-random"
-  s.version = "0.0.2"
-  s.licenses = ['MIT']
-  s.summary     = "A Jekyll plugin that generates pseudo-random data"
-  s.description = "A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data."
-  s.authors     = ["Paweł Kuna"]
-  s.email       = '[email protected]'
+  s.name          = "jekyll-random"
+  s.version       = "0.0.3"
+  s.licenses      = ['MIT']
+  s.summary       = "A Jekyll plugin that generates pseudo-random data"
+  s.description   = "A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data."
+  s.authors       = ["Paweł Kuna"]
+  s.email         = '[email protected]'
   s.files = [
     "lib/jekyll-random.rb"
   ]
-  s.homepage    = 'https://github.com/codecalm/jekyll-random'
-  s.metadata    = { "source_code_uri" => "https://github.com/codecalm/jekyll-random" }
+  s.require_paths = ['lib']
+  s.homepage      = 'https://github.com/codecalm/jekyll-random'
+  s.metadata      = { "source_code_uri" => "https://github.com/codecalm/jekyll-random" }
 
   s.add_dependency "jekyll", "~> 3.3"
 end