diff --git a/README.md b/README.md index d361adc..e289013 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,7 @@ p4RemoveUnversioned =================== Removes unversioned files from perforce repository. Script is in beta, and needs to undergo a partial re-write for super speed improvements. Right now doing individual p4 fstat calls, when it should be done on an entire directory. + +This script does parse __.p4ignore__ ignore files, compiles the fields as regex, and scans every directory and file against the local and parent __.p4ignore__ files. This is my first time doing something like this, and I just realized this isn't actually correct; I need to update how things are ignored to follow the [spec](http://www.perforce.com/perforce/r12.1/manuals/cmdref/env.P4IGNORE.html), since it's not straight up regex. + +**Files are currently permanently deleted, so use this at your own risk.** \ No newline at end of file