Add docs about -revert command.

Shrikant Sharat
1 parent d43f31a793
Showing 1 changed file with 11 additions and 0 deletions Side-by-side Diff
README.mkd
@@ -301,6 +301,17 @@ real quirky.
 **Please note**: This command is not for updating *antigen* itself. Its for
 updating the bundles you are using with antigen.
  
+### antigen-revert <sup>&alpha;</sup>
+
+Reverts the state of all your plugins to how they were before the last
+`antigen-update`. This command is currently experimental, so don't rely too much
+on it. There is a test for it, and it passes, so it should work fine though.
+
+Takes no options.
+
+Insider detail: The information for reverting is stored in
+`$ADOTDIR/revert-info` file.  If its not present, reverting is not possible.
+
 ### antigen-list
  
 Use this command to list out the currently *loaded* plugins. Keep in mind that
...	...	@@ -301,6 +301,17 @@ real quirky.
301	301	Please note: This command is not for updating antigen itself. Its for
302	302	updating the bundles you are using with antigen.
303	303
	304	+### antigen-revert <sup>α</sup>
	305	+
	306	+Reverts the state of all your plugins to how they were before the last
	307	+`antigen-update`. This command is currently experimental, so don't rely too much
	308	+on it. There is a test for it, and it passes, so it should work fine though.
	309	+
	310	+Takes no options.
	311	+
	312	+Insider detail: The information for reverting is stored in
	313	+`$ADOTDIR/revert-info` file. If its not present, reverting is not possible.
	314	+
304	315	### antigen-list
305	316
306	317	Use this command to list out the currently loaded plugins. Keep in mind that