Skip to content

Commit

Permalink
Update README [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
sferik committed May 7, 2012
1 parent 0d1f822 commit afea3d1
Showing 1 changed file with 54 additions and 37 deletions.
91 changes: 54 additions & 37 deletions README.md
@@ -1,13 +1,12 @@
# FCC Reboot
# FCC Reboot [![Build Status](https://secure.travis-ci.org/codeforamerica/fcc_reboot.png)][travis]
A Ruby wrapper for the FCC Reboot APIs.

## <a name="apps">Does your project or organization use this gem?</a>
Add it to the [apps](https://github.com/cfalabs/fcc_reboot/wiki/apps) wiki!
[travis]: http://travis-ci.org/codeforamerica/fcc_reboot

## <a name="ci">Continuous Integration</a>
[![Build Status](https://secure.travis-ci.org/codeforamerica/fcc_reboot.png)](http://travis-ci.org/codeforamerica/fcc_reboot)
## Does your project or organization use this gem?
Add it to the [apps](https://github.com/cfalabs/fcc_reboot/wiki/apps) wiki!

## <a name="installation">Installation</a>
## Installation
gem install fcc_reboot

## Read the FCC API Docs
Expand All @@ -16,7 +15,7 @@ Add it to the [apps](https://github.com/cfalabs/fcc_reboot/wiki/apps) wiki!
3. [Census Block](http://www.fcc.gov/developer/census-block-conversions-api)
4. [FCC Registration Number Conversions](http://www.fcc.gov/developer/frn-conversions-api)

## <a name="examples">Usage Examples</a>
## Usage Examples
require 'fcc_reboot'

# Provide speed test statistics for a US County given the passed Latitude and Longitude
Expand Down Expand Up @@ -49,8 +48,11 @@ Add it to the [apps](https://github.com/cfalabs/fcc_reboot/wiki/apps) wiki!
# Returns the license counts and percent distribution by status.
FccReboot.get_statuses(:commonName => 'Sprint Nextel')

## <a name="contributing">Contributing</a>
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
## Contributing
In the spirit of [free software][free-sw], **everyone** is encouraged to help improve
this project.

[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html

Here are some ways *you* can contribute:

Expand All @@ -59,33 +61,47 @@ Here are some ways *you* can contribute:
* 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 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/fcc_reboot/issues)
* by fixing [issues][]
* by reviewing patches

## <a name="issues">Submitting an Issue</a>
We use the [GitHub issue tracker](https://github.com/codeforamerica/fcc_reboot/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.

## <a name="pulls">Submitting a Pull Request</a>
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.)

## <a name="rubies">Supported Rubies</a>
This library aims to support and is [tested
against](http://travis-ci.org/codeforamerica/fcc_reboot) the following Ruby
* [financially][]

[issues]: https://github.com/codeforamerica/fcc_reboot/issues
[financially]: https://secure.codeforamerica.org/page/contribute

## Submitting an Issue
We use the [GitHub issue tracker][issues] to track bugs and features. Before
submitting a bug report or feature request, check to make sure it hasn't
already been submitted. When submitting a bug report, please include a [Gist][]
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.

[gist]: https://gist.github.com/

## Submitting a Pull Request
1. [Fork the repository.][fork]
2. [Create a topic branch.][branch]
3. Add specs for your unimplemented feature or bug fix.
4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
5. Implement your feature or bug fix.
6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
7. Run `open coverage/index.html`. If your changes are not completely covered
by your tests, return to step 3.
8. Add documentation for your feature or bug fix.
9. Run `bundle exec rake yard`. If your changes are not 100% documented, go
back to step 8.
10. Add, commit, and push your changes.
11. [Submit a pull request.][pr]

[fork]: http://help.github.com/fork-a-repo/
[branch]: http://learn.github.com/p/branching.html
[pr]: http://help.github.com/send-pull-requests/

## Supported Rubies
This library aims to support and is [tested against][travis] the following Ruby
implementations:

* Ruby 1.8.7
Expand All @@ -107,8 +123,9 @@ implementation, you will be personally responsible for providing patches in a
timely fashion. If critical issues for a particular implementation exist at the
time of a major release, support for that Ruby version may be dropped.

## <a name="copyright">Copyright</a>
Copyright (c) 2010 Code for America Laboratories
See [LICENSE](https://github.com/codeforamerica/fcc_reboot/blob/master/LICENSE.md) for details.
## Copyright
Copyright (c) 2010 Code for America. See [LICENSE][license] for details.

[license]: https://github.com/codeforamerica/fcc_reboot/blob/master/LICENSE.md

[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/fcc_reboot.png)](http://stats.codeforamerica.org/projects/fcc_reboot)

0 comments on commit afea3d1

Please sign in to comment.