README.md in ine-places-0.1.0 vs README.md in ine-places-0.1.1

- old
+ new

@@ -1,24 +1,28 @@ # INE Places gem [![Build Status](https://travis-ci.org/PopulateTools/ine-places.svg)](https://travis-ci.org/PopulateTools/ine-places) +[![Gem Version](https://badge.fury.io/rb/ine-places.svg)](https://badge.fury.io/rb/ine-places) INE Places gem aims to help you to deal with Autonomous Regions, Provinces and Municipalities from -Spain. This data is provided by the INE (Instituto Nacional Estadística) in this URL: +Spain. This data is provided by the INE (Instituto Nacional Estadística) in these URLs (see the [Data License](https://github.com/PopulateTools/ine-places/#data_license) section for details about reuse rights): -http://www.ine.es/daco/daco42/codmun/codmun11/11codmunmapa.htm +- http://www.ine.es/daco/daco42/codmun/codmun11/11codmunmapa.htm +- http://www.ine.es/jaxi/menu.do?type=pcaxis&path=/t20/e245/codmun&file=inebase&L=0 -According to that webpage the data **was updated on 01-01-2011**. As you might know municipalities -data changes along the years: sometimes two municipalities are merged in a single one. For this -reason it's important to know the date of the data. +According to that webpage the data **was updated the 3rd of February, 2015**. As you might know municipalities +data changes along the years: sometimes two municipalities are merged in a single one [more +information in Spanish](http://www.ine.es/daco/daco42/codmun/codmunmod.htm). For this +reason it's important to know the date of the data. The data included in this gem has been processed +based on the data published on the INE (so, it was processed after the 3rd of Feb, 2015). ## Installation Add this line to your application's Gemfile: ```ruby -gem 'ine-places' +gem 'ine-places', require: 'ine/places/places' ``` And then execute: $ bundle @@ -27,11 +31,11 @@ $ gem install ine-places ## Usage -This gem provides three models: +This gem provides three Ruby classes: - `INE::Places::AutonomousRegion` - `INE::Places::Province` @@ -46,11 +50,11 @@ The attributes of this model are: - id: INE code - name: the official name in the INE -- slug: a sanitized name, valid for URLs +- slug: a sanitized unique name, valid for URLs - lon: longitude of the central point - lat: latitude of the central point To obtain all the autonomous regions: @@ -85,11 +89,11 @@ The attributes of this model are: - id: INE code - name: the official name in the INE -- slug: a sanitized name, valid for URLs +- slug: a sanitized unique name, valid for URLs - autonomous_region_id: the INE code of the autonomous region - autonomous_region: the AutonomousRegion object - lon: longitude of the central point - lat: latitude of the central point @@ -126,11 +130,11 @@ The attributes of this model are: - id: INE code - name: the official name in the INE -- slug: a sanitized name, valid for URLs +- slug: a sanitized unique name, valid for URLs - province_id: the INE code of the province - province: the Province object - lon: longitude of the central point - lat: latitude of the central point @@ -167,10 +171,18 @@ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/PopulateTools/ine-places. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/PopulateTools/ine-places. 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](CODE_OF_CONDUCT.md). + +## Data License + +We have created the CSV files we use as source for the gem to make data availabale from data extracted from INE. In spanish and according to INE's own formula: + +_Elaboración propia con datos extraídos del sitio web del INE: www.ine.es_ + +Please read the conditions about reusing the data provided by this gem in INE's [Licensing page](http://www.ine.es/ss/Satellite?L=0&c=Page&cid=1254735849170&p=1254735849170&pagename=Ayuda%2FINELayout#) (in spanish). ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).