README.rdoc in mercurial-ruby-0.7.0 vs README.rdoc in mercurial-ruby-0.7.1

- old
+ new

@@ -50,19 +50,26 @@ == Features === Mercurial Entities +* {Mercurial::Repository Repository} +* {Mercurial::ConfigFile .hgrc} — hooks and various settings * {Mercurial::Commit Commits} * {Mercurial::Node Nodes} — files and directories * {Mercurial::Branch Branches} * {Mercurial::Tag Tags} * {Mercurial::Diff Diffs} +* {Mercurial::Blame Blame} * {Mercurial::Manifest Manifest} * {Mercurial::FileIndex File Index} -* {Mercurial::ConfigFile Repository config} — hooks and various settings +=== Custom Commands + +You can use {Mercurial::Shell Shell} class to execute custom shell commands that +weren't added to the gem as first-class citizens yet. + === Built-in Caching There's a simple caching mechanism built into the gem. If you pass Rails CacheStore compatible caching store to the Configuration block, mercurial-ruby will cache output of all hg commands it's executing. Then if you execute same method again and it will run the same command, @@ -74,9 +81,15 @@ conf.cache_store = Rails.cache end The gem is using a single method of the CacheStore called +fetch+. Cache expires automatically when repository's mtime changes, and it's your job to update it. + +=== Built-in Timeouts + +You can provide a timeout for pretty much any command you are running. Do it like this: + + repository.commits.all(:timeout => 5) == Contributing to mercurial-ruby * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it