Commits

WAKAYAMA shirou committed 6e36617

update README.

Comments (0)

Files changed (1)

 
 where you want the list of commits to appear.
 
+Options
+=============
+
+repo_root_path
+  specify repository root (default: ".")
+max_commits
+  set max commits to include (default: 10)
+branch
+  specify which branch to include (default: "default")
+path
+  specify the path to include (default: all)
+
+  NOTE: you need to set from repository root.
+
+Example
+===========
+
+::
+
+  .. hg_changelog::
+     :repo_root_path: ../..
+     :max_commits: 2
+     :path: test/rst
 
 Acknowledgement
 ================