Skip to content

Commit

Permalink
Add MIT License and update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jdpace committed Aug 16, 2010
1 parent b98ebd0 commit a43dcc0
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 5 deletions.
20 changes: 20 additions & 0 deletions LICENSE
@@ -0,0 +1,20 @@
Copyright (c) 2010 Jared Pace

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.
40 changes: 35 additions & 5 deletions README.md
Expand Up @@ -9,7 +9,7 @@ Rails applications. If you're uncomfortable with any step below then Errbit is n
for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at
[Thoughbot](http://thoughtbot.com), which Errbit is based on.

Set your local box or server(Ubuntu):
*Set your local box or server(Ubuntu):*
1. Install MongoDB
* Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages) then:

Expand All @@ -23,17 +23,47 @@ Set your local box or server(Ubuntu):
3. Install Bundler

gem install bundler --pre
*Running Locally:*
1. Bootstrap Errbit. This will copy over config.yml and also seed the database.

rake errbit:bootstrap

2. Update the config.yml and mongoid.yml files with information about your environment
3. Install dependencies

bundle install

4. Start Server

script/rails server

Deploy:
*Deploying:*
1. Bootstrap Errbit. This will copy over config.yml and also seed the database.

rake errbit:bootstrap
rake errbit:bootstrap

2. Update the config.yml file with information about your server
2. Update the deploy.rb file with information about your server
3. cap deploy:setup deploy

TODO
----

Add a deployment view
Add ability for watchers to be configured for types of notifications they should receive
Add ability for watchers to be configured for types of notifications they should receive

Contributing
------------

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with Rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

Copyright
---------

Copyright (c) 2010 Jared Pace. See LICENSE for details.

0 comments on commit a43dcc0

Please sign in to comment.