#Commons
=======
A Ruby wrapper for the Civic Commons MarketPlace API at [http://marketplace.civiccommons.org/api](http://marketplace.civiccommons.org/api)
Does your project or organization use this gem?
------------------------------------------
Add it to the [apps](http://github.com/codeforamerica/commons/wiki/apps) wiki!
Installation
------------
$ gem install commons
Documentation
-------------
[http://rdoc.info/gems/commons](http://rdoc.info/gems/commons)
Continuous Integration
----------------------
[](http://travis-ci.org/codeforamerica/commons)
Usage Examples
--------------
require 'commons'
@client = Commons::Client::New
a = @client.content("13813")
a.title # => "YouTown"
Contributing
------------
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
Here are some ways *you* can contribute:
* by using alpha, beta, and prerelease versions
* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by resolving [issues](http://github.com/codeforamerica/commons/issues)
* by reviewing patches
Submitting an Issue
-------------------
We use the [GitHub issue tracker](http://github.com/codeforamerica/commons/issues) to track bugs and
features. Before submitting a bug report or feature request, check to make sure it hasn't already
been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
operating system. Ideally, a bug report should include a pull request with failing specs.
Submitting a Pull Request
-------------------------
1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix.
4. Add documentation for your feature or bug fix.
5. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
6. Add specs for your feature or bug fix.
7. Run bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
8. Commit and push your changes.
9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
Copyright
---------
Copyright (c) 2010 Code for America Laboratories
See [LICENSE](https://github.com/cfalabs/commons/blob/master/LICENSE.md) for details.
[](http://stats.codeforamerica.org/projects/commons)