choteaumt
/
adopt-a-hydrant
mirror of https://github.com/choteaumt/adopt-a-hydrant.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Switch up Markdown syntax for headers [ci skip]

This commit is contained in:
Erik Michaels-Ober 2011-08-19 13:29:45 -07:00
parent 40b503e44b
commit b7f9de1930
1 changed files with 11 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,32 +1,25 @@
Adopt a Hydrant
===============
# Adopt a Hydrant
Claim responsibility for shoveling out a fire hydrant after it snows.
<a name="screenshots">Screenshot</a>
----------
## <a name="screenshots">Screenshot</a>
![Adopt a Hydrant](https://github.com/codeforamerica/adopt-a-hydrant/raw/master/screenshot.png "Adopt a Hydrant")
<a name="ci">Continuous Integration</a>
----------------------
## <a name="ci">Continuous Integration</a>
[![Build Status](https://secure.travis-ci.org/codeforamerica/adopt-a-hydrant.png)](http://travis-ci.org/codeforamerica/adopt-a-hydrant)
<a name="demo">Demo</a>
----
## <a name="demo">Demo</a>
You can see a running version of the application at
[http://adopt-a-hydrant.herokuapp.com/](http://adopt-a-hydrant.herokuapp.com/).
<a name="installation">Installation</a>
------------
## <a name="installation">Installation</a>
git clone git://github.com/codeforamerica/adopt-a-hydrant.git
cd adopt-a-hydrant
bundle install
<a name="usage">Usage</a>
-----
## <a name="usage">Usage</a>
rails server
<a name="contributing">Contributing</a>
------------
## <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.
Here are some ways *you* can contribute:
@ -42,8 +35,7 @@ Here are some ways *you* can contribute:
* by reviewing patches
* [financially](https://secure.codeforamerica.org/page/contribute)
<a name="issues">Submitting an Issue</a>
-------------------
## <a name="issues">Submitting an Issue</a>
We use the [GitHub issue tracker](https://github.com/codeforamerica/adopt-a-hydrant/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
@ -51,8 +43,7 @@ bug report, please include a [Gist](https://gist.github.com/) that includes a st
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>
-------------------------
## <a name="pulls">Submitting a Pull Request</a>
1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix.
@ -61,8 +52,7 @@ operating system. Ideally, a bug report should include a pull request with faili
6. Commit and push your changes.
7. Submit a pull request. Please do not include changes to the gemspec or version 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>
----------------
## <a name="rubies">Supported Rubies</a>
This library aims to support and is [tested
against](http://travis-ci.org/codeforamerica/adopt-a-hydrant) the following
Ruby implementations:
@ -85,8 +75,7 @@ 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>
---------
## <a name="copyright">Copyright</a>
Copyright (c) 2011 Code for America.
See [LICENSE](https://github.com/codeforamerica/adopt-a-hydrant/blob/master/LICENSE.md) for details.