Skip to content

Commit

Permalink
Update README and add MIT license
Browse files Browse the repository at this point in the history
  • Loading branch information
maccman committed Nov 28, 2013
1 parent f329a22 commit 5357772
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 9 deletions.
20 changes: 20 additions & 0 deletions MIT-LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2013 Alexander MacCaw ([email protected])

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.
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
# Setup
## Monocle

bundle install
createdb monocle_development
rake db:migrate
Monocle is a link and news aggregation website.

export GITHUB_KEY=123
export GITHUB_SECRET=123
http://monocle.io

export TWITTER_KEY=123
export TWITTER_SECRET=123
### Prerequisites

thin start
* Ruby 2.0
* Postgres
* Redis
* A GitHub app account
* A Twitter app account

### Setup

bundle install
createdb monocle_development
rake db:migrate

export GITHUB_KEY=123
export GITHUB_SECRET=123

export TWITTER_KEY=123
export TWITTER_SECRET=123

thin start

0 comments on commit 5357772

Please sign in to comment.