Description: What does this project do and who does it serve?
How do I, as a developer, start working on the project?
- What dependencies does it have (where are they expressed) and how do I install them?
- How can I see the project working before I change anything?
How do I run the project's automated tests?
rake spec
- Run other local services / provide credentials for external services.
rake spec:integration
- Required heroku addons, packages, or chef recipes.
- Required environment variables or credentials not included in git.
- Monitoring services and logging.
Examples of common tasks
e.g.
- How to make curl requests while authenticated via oauth.
- How to monitor background jobs.
- How to run the app through a proxy.
- Next feature 1
- Next feature 2
- Next feature 3
####Changelog
- Fork it
- Create your feature branch (
git checkout -b feature/my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin feature/my-new-feature) - Create new Pull Request
We are grateful to the maintainers, contributors, and sponsors of the following technologies which make Project possible:
- project_name (project_description)
Copyright (c) 2012 ExactTarget
Licensed under the MIT License (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the COPYING file.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.