expand readme, include license

Author: trepmal

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Kailey Lampert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

readme.md

@@ -1,14 +1,70 @@
-Revisions CLI
-=============
+# Revisions CLI
 
-Requires [wp-cli](http://wp-cli.org).
+WP CLI command for managing revisions
 
-Install this as a normal plugin, then run `wp help revisions`
+## Installation
 
+### as standard plugin
+
+```
+wp plugin install https://github.com/trepmal/wp-revisions-cli/archive/master.zip --activate
+```
+
+### as wp-cli package (coming soooooooon, hopefully)
+
+```
+# wp package install trepmal/wp-revisions-cli
 ```
-clean         Clean out old revisions
-dump          Dump all revisions
-generate      Generate revisions
-list          List all revisions
-status        Get revision status
-```
+
+## Usage
+
+
+For a rundown of all commands at any time, run `wp help revisions`
+
+
+### `wp revisions clean [<keep>]`
+
+`<keep>` is an integer, defaults to value of `WP_POST_REVISIONS`
+
+For all posts, keep only the last *keep* revisions for all posts.
+
+ - `--post_type=<post_type>` Clean revisions for given post type
+ - `--post_id=<post_id>` Clean revisions for given post. (Does not yet accept lists)
+ - `--hard` use `wp_delete_post_revision()` when deleting, this picks up any potential related data such as meta or comments.
+
+### `wp revisions dump`
+
+Dump all revisions for all posts. Equivalent to `wp revisions clean -1`
+
+ - `--hard` use `wp_delete_post_revision()` when deleting, this picks up any potential related data such as meta or comments.
+ - `--yes` answer 'yes' to confirmation message
+
+### `wp revisions generate [<count>]`
+
+`<count>` *integer* Number of revisions to generate per post. Default 15
+
+Generate revisions for posts.
+
+ - `--post_type=<post_type>` Generate revisions for given post type
+ - `--post_id=<post_id>` Generate revisions for given post. (Does not yet accept lists)
+
+### `wp revisions list`
+
+List revisions.
+
+ - `--post_type=<post_type>` Generate revisions for given post type
+ - `--post_id=<post_id>` Generate revisions for given post. (Does not yet accept lists)
+ - `--yes` answer 'yes' to confirmation message
+
+### `wp revisions status`
+
+Get revisions status. Namely, the value of `WP_POST_REVISIONS`
+
+
+## Credits
+
+## License
+
+The MIT License (MIT)  
+Copyright (c) 2016 Kailey Lampert  
+[Full text license](LICENSE)