Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Replace placeholder README with actual README
- Loading branch information
Showing
1 changed file
with
61 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,71 @@ | ||
# The Code for America RubyGem template | ||
# Futures Pipeline | ||
|
||
If you want to create a new Code for America gem, you can use this gem as a template. | ||
It's similar to [suspenders][suspenders], but for RubyGems instead of Rails. | ||
Ruby wrapper for the Futures, Inc. US Military Pipeline API | ||
|
||
[suspenders]: https://github.com/thoughtbot/suspenders | ||
Installation | ||
------------ | ||
gem install futures_pipeline | ||
|
||
For more information on RubyGems, you should read the [RubyGems Manuals][manuals]. | ||
Documentation | ||
------------- | ||
[http://rdoc.info/gems/futures_pipeline](http://rdoc.info/gems/futures_pipeline) | ||
|
||
[manuals]: http://docs.rubygems.org/ | ||
Continuous Integration | ||
---------------------- | ||
[![Build Status](http://travis-ci.org/codeforamerica/futures_pipeline.png)](http://travis-ci.org/codeforamerica/futures_pipeline) | ||
|
||
After cloning this gem, you'll want to make the following changes: | ||
Usage Examples | ||
-------------- | ||
require 'futures_pipeline' | ||
|
||
1. Replace all instances of gem_template and GemTemplate with the snake_case and CamelCase name of your gem, respectively | ||
2. Add a summary and description to the [gemspec][gemspec] file | ||
@client = FuturesPipeline.new | ||
@client.careers # Return an array of 50 careers | ||
@client.careers.first # Return an array of 50 careers | ||
@client.careers.first.title # => "Chief Executives" | ||
@client.careers.first.onet_soc_code # => "11-1011.00" | ||
@client.career("11-1011.00") # Return detailed information about Chief Executives | ||
|
||
[gemspec]: https://github.com/codeforamerica/gem_template/blob/master/gem_template.gemspec | ||
Contributing | ||
------------ | ||
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project. | ||
|
||
This template includes: | ||
Here are some ways *you* can contribute: | ||
|
||
* [RSpec][rspec] for isolation testing | ||
* [SimpleCov][simplecov] for C0 code coverage | ||
* [ZenTest][zentest] for continuous testing | ||
* [YARD][yard] for documentation | ||
* 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](https://github.com/codeforamerica/futures_pipeline/issues) | ||
* by reviewing patches | ||
* [financially](https://secure.codeforamerica.org/page/contribute) | ||
|
||
[rspec]: https://github.com/rspec/rspec | ||
[simplecov]: https://github.com/colszowka/simplecov | ||
[zentest]: https://github.com/seattlerb/zentest | ||
[yard]: https://github.com/lsegal/yard | ||
Submitting an Issue | ||
------------------- | ||
We use the [GitHub issue tracker](https://github.com/codeforamerica/futures_pipeline/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](https://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 <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4. | ||
6. Add specs for your feature or bug fix. | ||
7. Run <tt>bundle exec rake spec</tt>. 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) 2011 Code for America. | ||
See [LICENSE](https://github.com/codeforamerica/futures_pipeline/blob/master/LICENSE.md) for details. |