jekyll-autoscout24 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02d7701b035b6fa2cb2f7a2564d487aa3fd54f1
-  data.tar.gz: 0c8ce16e97b931d7026d7765992d2b64ebef3489
+  metadata.gz: 081a990a4c3c571c35441800b3be54cb7d50338b
+  data.tar.gz: 6e6ad1cef0d08c18bf39c8bd1504ac529c38311f
 SHA512:
-  metadata.gz: 7e7090122b798fa433c3fa4e1da37e334f0b7361f3543ebef01a4c0e7be1e62c41baea02c590d3a296a4cf60997430a78fe12b4780c8d75aed31c82046e9c2b4
-  data.tar.gz: 61005d4eb3703067c803225bf9f2b90fff202d258ad26dfbe653540e85b2fa83f8d3d3db77cdee95a6d9e70b7acd9ad67367cbbfd1dce38d8be2fb17dafe3f96
+  metadata.gz: e820b4d4172747c8d9894ab2dd466771fbdae6094426339d95e7026be5fc7b546e2ab73b5c71be0b3ed9f642c47e79709f46b8f94813458d9ba8f19e1038301c
+  data.tar.gz: d89d80c998296856f86d8c11b315157a12223cba85b5d9922af5e5626094aa602820d2cb17fdccacbd55849206b44e6f0a369150981b452a2117cfafe1470b4b

data/README.md

@@ -1,31 +1,35 @@
 # Jekyll::Autoscout24
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/autoscout24`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Jekyll plugin that provides owners of an Autoscout24 account a bridge between their backup XML file and a Jekyll site.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+You have 3 options for installing jekyll-autoscout24:
 
-```ruby
-gem 'jekyll-autoscout24'
-```
+1. In your site source root, make a `_plugins` directory. Place your plugin here.
+Any file ending in `*.rb` inside this directory will be loaded before Jekyll generates your site.
 
-And then execute:
+2. In your `_config.yml` file, add a new array with the key `plugins` (or `gems` for Jekyll < `3.5.0`) and the values of the gem name of the plugin:
+
+```
+plugins:
+  - jekyll-autoscout24
+```
 
-    $ bundle
+Then install your plugin using `gem install jekyll-autoscout24`
 
-Or install it yourself as:
+3. Add the plugin to a Bundler group in your `Gemfile`. An example:
 
-    $ gem install jekyll-autoscout24
+```
+group :jekyll_plugins do
+gem "jekyll-autoscout24"
+end
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-The plugin jekyll-autoscout24 add to your jekyll project a folder called *autoscout24backup* in which you must put the *autoscout24backup.xml* file previously downloaded from your account AutoScout24.
-Soon continued..
+1. In your site source root, make a `backup` directory. Place your `autoscout24.xml` file here.
+2. Start Jekyll as you would normally (`bundle exec jekyll serve`).
 
 ## Development
 
@@ -37,7 +41,7 @@ To validate changes end-2-end, run `bundle install` in test/test-site and then r
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-autoscout24. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/staticpagesio/jekyll-autoscout24. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/jekyll-autoscout24.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "liquid", "4.0.0"
   spec.add_dependency "jekyll", ENV["JEKYLL_VERSION"] ? "~> #{ENV["JEKYLL_VERSION"]}" : "~> 3.1"
 
+  spec.add_development_dependency "gem-release", "1.0.0"
   spec.add_development_dependency "bundler", "1.16.1"
   spec.add_development_dependency "rake", "12.3.0"
   spec.add_development_dependency "minitest", "~> 5.11.3"
-  spec.add_development_dependency "gem-release", "1.0.0"
 end

data/lib/jekyll-autoscout24/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Autoscout24
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-autoscout24
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Enrico Caputo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -53,6 +53,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +109,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 5.11.3
-- !ruby/object:Gem::Dependency
-  name: gem-release
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 description: A Jekyll plugin to transform AutoScout24's backup XML into a data file
 email:
 - enricocaputo.1972@gmail.com