README.md in lita-locker-1.0.10 vs README.md in lita-locker-1.1.0

- old
+ new

@@ -17,12 +17,21 @@ gem "lita-locker" ``` ## Configuration -None +### Optional attributes +* `per_page` - The number of items to show at once when listing labels or resources. Default: 10 + +### Example + +``` ruby +Lita.configure do |config| + config.handlers.locker.per_page = 3 +``` + ## Usage lita-locker allows you to define resources (such as a server, or Git repo), and labels (such as "production"). Labels can have multiple resources, and resources can be referenced by multiple labels. A label can only be locked @@ -59,23 +68,23 @@ locker dequeue <label> - Remove yourself from the queue for <label> ``` ### Labels ``` -locker label list - List all labels +locker label list [--page N] - List all labels locker label create <name> - Create a label with <name>. locker label delete <name> - Delete the label with <name>. Clears all locks associated. locker label add <resource> to <name> - Adds <resource> to the list of things to lock/unlock for <name> locker label remove <resource> from <name> - Removes <resource> from <name> locker label show <name> - Show all resources for <name> ``` ### Resources ``` -locker resource list - List all resources -locker resource create <name> - Create a resource with <name>. (Restricted to locker_admins group) -locker resource delete <name> - Delete the resource with <name>. Clears all locks associated. (Restricted to locker_admins group) -locker resource show <name> - Show the state of <name> +locker resource list [--page N] - List all resources +locker resource create <name> - Create a resource with <name>. (Restricted to locker_admins group) +locker resource delete <name> - Delete the resource with <name>. Clears all locks associated. (Restricted to locker_admins group) +locker resource show <name> - Show the state of <name> ``` ### HTTP access ``` curl http://lita.example.com/locker/label/<name> - Get current <name> status