Skip to content
Browse files

README

  • Loading branch information...
1 parent 92eadb5 commit 88f05b4d455cb96b34ebfdf4a74a118e18fc2f94 @dce dce committed
Showing with 46 additions and 5 deletions.
  1. +1 −1 MIT-LICENSE
  2. +44 −0 README.markdown
  3. +0 −3 README.rdoc
  4. BIN screenshot.png
  5. +1 −1 stat_board.gemspec
View
2 MIT-LICENSE
@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 David Eisinger (Viget)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
44 README.markdown
@@ -0,0 +1,44 @@
+StatBoard
+=========
+
+A simple dashboard of records created this week, this month, and all time, mountable as a Rails Engine.
+
+<img src="https://raw.github.com/vigetlabs/stat_board/master/screenshot.png" />
+
+## Basic Configuration
+
+1. Add gem to `Gemfile`:
+
+ gem 'stat_board'
+
+2. Mount engine (in `config/routes.rb`):
+
+ YourApp::Application.routes.draw do
+ mount StatBoard::Engine, :at => "/stats"
+
+3. Configure models (in `config/initializers/stat_board.rb`):
+
+ StatBoard.models = [User, Post, Comment]
+
+## Additonal Configuration
+
+In `config/initializers/stat_board.rb`:
+
+1. Title
+
+ StatBoard.title = "YourApp Stats"
+
+2. Basic Authentication
+
+ StatBoard.username = "user"
+ StatBoard.password = "pass"
+
+## Contributing
+
+Happily accepting contributions to improve StatBoard. To contribute, fork, add your thing, add some specs, and send a pleasantly worded pull request.
+
+* * *
+
+StatBoard is released under the [MIT License][mit]. See MIT-LICENSE for further details.
+
+[mit]: http://www.opensource.org/licenses/MIT
View
3 README.rdoc
@@ -1,3 +0,0 @@
-= StatBoard
-
-This project rocks and uses MIT-LICENSE.
View
BIN screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
2 stat_board.gemspec
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
s.summary = "Simple dashboard of records created this week, this month, and all time, mountable as a Rails Engine."
s.description = "Simple dashboard of records created this week, this month, and all time, mountable as a Rails Engine."
- s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
+ s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.markdown"]
s.test_files = Dir["test/**/*"]
s.add_dependency "rails", "~> 3.2"

0 comments on commit 88f05b4

Please sign in to comment.
Something went wrong with that request. Please try again.