Add docs on `--force` argument of `-cleanup` command.

Shrikant Sharat
1 parent c90b21fa31
Showing 1 changed file with 4 additions and 2 deletions Side-by-side Diff
README.mkd
@@ -278,8 +278,10 @@ Used to clean up the clones of repos which are not used by any plugins. It takes
 no arguments. When this is run, it lists out the repo-clones that are available
 but are not used by any plugin *currently loaded*.
  
-This command currently cannot run in a non-interactive mode. So it won't be very
-pleasant to use it in your `.zshrc`.
+This command, by default asks for confirmation before deleting the unused
+clones. If the `--force` argument is given, then this confirmation is not asked.
+It straight away deletes all the unused clones. This option makes this command
+usable in a non-interactive fashion.
  
 ### antigen-lib
...	...	@@ -278,8 +278,10 @@ Used to clean up the clones of repos which are not used by any plugins. It takes
278	278	no arguments. When this is run, it lists out the repo-clones that are available
279	279	but are not used by any plugin currently loaded.
280	280
281		-This command currently cannot run in a non-interactive mode. So it won't be very
282		-pleasant to use it in your `.zshrc`.
	281	+This command, by default asks for confirmation before deleting the unused
	282	+clones. If the `--force` argument is given, then this confirmation is not asked.
	283	+It straight away deletes all the unused clones. This option makes this command
	284	+usable in a non-interactive fashion.
283	285
284	286	### antigen-lib
285	287