Nicolas Évrard avatar Nicolas Évrard committed 0744e0d

Put some real information in the README

Comments (0)

Files changed (1)

-hgnested
+hgreview
 ========
 
 Mercurial extension to work with rietveld code review.
 
 See `hg help hgreview` for the complete list of commands.
 
+Options
+-------
+
+-r VALUE         Add reviewers
+-i VALUE         Issue number. Defaults to new issue
+-m VALUE         Codereview message
+--rev VALUE      Revision number to diff against
+--send_email     Send notification email to reviewers
+--id             Output issue id
+--url            Output issue URL
+--fetch          Fetch patch and apply to repository
+
+.hgrc options
+-------------
+
+In the review section of the .hgrc file you can specify some default
+information:
+
+server
+    URL of the rietveld instance to use
+
+username
+    Username on the rietveld instance
+
+host_header
+    Alternate hostname to use in the `Host:` header
+
+account_type
+    Account type for authentication either 'GOOGLE' or 'HOSTED'
+
+cc_header
+    Comma separated value of username / email in CC of the review 
+
+send_email
+    A boolean to indicate if the rietveld instance should or not send emails
+    after the review has been submitted
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.