README.md in reso-0.1.6.7 vs README.md in reso-0.2.2
- old
+ new
@@ -1,149 +1,43 @@
-# RESO Data Dictionary
+# Reso
-The RESO Data Dictionary gem is an ongoing effort to provide data models and data import based on the Real Estate Standardization Organization Data Dictionary syndication format for exchange of real estate listing data.
+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/reso`. To experiment with that code, run `bin/console` for an interactive prompt.
-Read more here:
-http://www.reso.org/schemas-for-syndication
+TODO: Delete this and the text above, and describe your gem
-This gem has been written for MySQL. If you test it using another RDBMS, let me know the result.
-
-
## Installation
Add this line to your application's Gemfile:
- gem 'reso'
+```ruby
+gem 'reso'
+```
-And then install:
+And then execute:
$ bundle
-Run the generator to copy migrations to your app:
+Or install it yourself as:
- $ rails g reso:install
+ $ gem install reso
-Create the database:
-
- $ rake db:create
-
-Run the migrations:
-
- $ rake db:migrate
-
-Populate the database with necessary seed data:
-
- $ rake reso:seed
-
-Populate the database with an example listing:
-
- $ rake reso:import
-
-This will download and install an example listing in the RESO format, as provided by ListHub, the largest US listing syndicator. The information needed is populated by the seed task through the Import model. If you want to add your own import, you would open the console and create an import:
-
- > Import.create(token: 'myimport', name: 'My Import', source_url: 'http://somewebsite.com/myfeed.xml')
-
-You would then import it by passing the token value to the import rake task:
-
- $ rake reso:import[myimport]
-
-
## Usage
-Fetch a listing:
+TODO: Write usage instructions here
- @listing = Listing.first
+## Development
-Access direct attributes:
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
- @listing.list_price
- @listing.list_price_low
- @listing.listing_url
- @listing.lead_routing_email
- @listing.bedrooms
- @listing.bathrooms
- @listing.listing_key
- @listing.permit_address_on_internet
- @listing.vow_address_display
- @listing.vow_automated_valuation_display
- @listing.vow_consumer_comment
- @listing.disclose_address
- @listing.short_sale
- @listing.listing_description
- @listing.listing_service_identifier
- @listing.living_area
- @listing.lot_size
- @listing.lot_size_unit
- @listing.listing_date
- @listing.listing_title
- @listing.full_bathrooms
- @listing.three_quarter_bathrooms
- @listing.half_bathrooms
- @listing.one_quarter_bathrooms
- @listing.partial_bathrooms
- @listing.latitude
- @listing.longitude
- @listing.directions
- @listing.elevation
- @listing.geocode_options
- @listing.parcel_info
- @listing.year_built
- @listing.year_updated
- @listing.building_unit_count
- @listing.num_floors
- @listing.condo_floor_num
- @listing.num_parking_spaces
- @listing.room_count
- @listing.legal_description
+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).
-Access related models:
+## Contributing
- @listing.address
- @listing.alternate_prices
- @listing.appliances
- @listing.architecture_style
- @listing.brokerage
- @listing.builders
- @listing.community
- @listing.cooling_systems
- @listing.county
- @listing.expenses
- @listing.exterior_types
- @listing.floor_coverings
- @listing.foreclosure_status
- @listing.franchises
- @listing.heating_fuels
- @listing.heating_systems
- @listing.home_features
- @listing.listing_category
- @listing.listing_office
- @listing.listing_provider
- @listing.listing_service
- @listing.listing_status
- @listing.multiple_listing_service
- @listing.neighborhoods
- @listing.offices
- @listing.open_houses
- @listing.parking
- @listing.participants
- @listing.photos
- @listing.property_sub_type
- @listing.property_type
- @listing.roof_types
- @listing.rooms
- @listing.taxes
- @listing.videos
- @listing.view_types
- @listing.virtual_tours
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/reso. 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.
-Other:
-
- @brokerage.address
- @builder.address
- @franchise.address
-
## License
-MIT License. Copyright 2013-2015 Michael Edlund, medlund@mac.com.
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
+## Code of Conduct
+Everyone interacting in the Reso project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/reso/blob/master/CODE_OF_CONDUCT.md).