Skip to content
This repository has been archived by the owner on Mar 9, 2021. It is now read-only.

Commit

Permalink
Add LICENSE and improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
etagwerker committed Feb 26, 2016
1 parent ac1cd55 commit 26578c6
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 15 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 OmbuLabs

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
43 changes: 28 additions & 15 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,41 @@
== README
# Infractores

This README would normally document whatever steps are necessary to get the
application up and running.
Infractores is a tool that lets anyone with a Twitter account report an infraction using a tweet.

Things you may want to cover:
The infractions are recorded and placed in a map along with the evidence supporting the report.

* Ruby version
## Considerations

* System dependencies
The project uses a Twitter application to find the tweets that describe an infraction. It also uses Amazon Web Services to store the evidence related to the infraction.

* Configuration
### Requirements

* Database creation
* Postgres 9.4.1+
* Redis 3.0.1+
* Ruby 2.2.1

* Database initialization
## Setup

* How to run the test suite
### Setup your environment

* Services (job queues, cache servers, search engines, etc.)
cp .env.sample .env

* Deployment instructions
You will **need** to enter your AWS and Twitter credentials in this file.

* ...
### Setup your database

rake db:create db:migrate

Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.
### Get infractions from Twitter

rake twitter:download_tweets

## Start

foreman start

This will start the Rails server and a Sidekiq worker to process the tweets.

## License

[license]: LICENSE

0 comments on commit 26578c6

Please sign in to comment.