diff --git a/README.md b/README.md index d2ca56c..81e37c0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ # find -Allows searching for items within a players various storage containers via a slash command. \ No newline at end of file +Allows searching for items within a players various storage containers via a slash command (case insensitive). + +## Examples ## + +``` +/find helm +``` + +Searches all of player's inventory for items whose name contains "helm", including storage slips. +![Example 1](screenshots/ex1.png) + +``` +/findmore continent +``` + +Searches all of player's inventory for items whose descriptions contain "continent". + +![Example 2](screenshots/ex2.png) + +``` +/findslips (#) +``` + +Displays any items in players inventory that can be stored in Storage Slips #1-27. If an optional #1-27 is specified, +only items that can be stored in that Slip# will be displayed. + +![Example 3](screenshots/ex3.png) + +``` +/finddupes +``` + +Returns list of duplicate items, i.e. which occupy 2 or more inventory slots. (Output is: item name, # of item slots). + +![Example 4](screenshots/ex4a.png) +![Example 4](screenshots/ex4b.png) \ No newline at end of file diff --git a/screenshots/ex1.png b/screenshots/ex1.png new file mode 100644 index 0000000..2dbdae1 Binary files /dev/null and b/screenshots/ex1.png differ diff --git a/screenshots/ex2.png b/screenshots/ex2.png new file mode 100644 index 0000000..18d3d95 Binary files /dev/null and b/screenshots/ex2.png differ diff --git a/screenshots/ex3.png b/screenshots/ex3.png new file mode 100644 index 0000000..4e36e87 Binary files /dev/null and b/screenshots/ex3.png differ diff --git a/screenshots/ex4a.png b/screenshots/ex4a.png new file mode 100644 index 0000000..38f74f3 Binary files /dev/null and b/screenshots/ex4a.png differ diff --git a/screenshots/ex4b.png b/screenshots/ex4b.png new file mode 100644 index 0000000..89a99ca Binary files /dev/null and b/screenshots/ex4b.png differ