Permalink
Browse files

updated readme

  • Loading branch information...
1 parent 474b261 commit 5ce75d3fa7d729fab5bf9be795264eca374cc9af @robertgreiner committed Jan 20, 2012
Showing with 2 additions and 2 deletions.
  1. +2 −2 readme.md
View
@@ -14,10 +14,10 @@ Getting started with tipster in 3 easy steps:
### Create ruby file
-The default repository path is the local directory tipster is run in. The default commit ID is HEAD.
+`number_of_commits` will tell tipster to build an HTML report for the current `commit_id` and the previous x commits.
require 'tipster'
- Tipster.new(['/path/to/repository']).html_report ['commit_id']
+ Tipster.new(['/path/to/repository' = "."]).html_report(['commit_id' = HEAD], [number_of_commits = 1])
### Run!

0 comments on commit 5ce75d3

Please sign in to comment.