diff --git a/README.md b/README.md index 5e6e987..2718c8f 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ We provide three different themes to match the look and feel of the official Tea ## Installation / Configuration +### Options + Upon initialization, the plugin takes the following options: | Key | Default | Optional | Description | @@ -37,14 +39,32 @@ Both API endpoint URLs support variables such as `$host`, `$port` and `$icon` fo The `$icon` variable will be replaced by the crc32 polynomial of the icon file. This is an unsigned integer equal to the icon ID that is used as a value for the `i_icon_id` permission on a TeamSpeak 3 Server. +### Quick Start + +To add the TSViewer to your site, simply include jQuery and the plugin on a page. Then select a container element and call the `tsviewer` method with the IP address and port number of your TeamSpeak 3 Server. + +```html +
+ + + + + +``` + +### Customization + The tooltip patterns can be customized with several property variables taken from the JSON result. For example, this is what a server/client tooltip pattern could look like: Version $version on $platform In addition, you can specify callbacks for advanced code enhancements such as context menus or drag & drop. -To add the TSViewer to your site, simply include jQuery and the plugin on a page. Then select a container element and call the `tsviewer` method with the IP address and port number of your TeamSpeak 3 Server. - ```html
@@ -52,14 +72,12 @@ To add the TSViewer to your site, simply include jQuery and the plugin on a page ```