From fbb0b76949ec200216e78484f5ab6170e1e2228e Mon Sep 17 00:00:00 2001 From: John Rummell Date: Fri, 4 Dec 2015 19:27:12 -0500 Subject: [PATCH] Added usage and demo link to readme --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 64 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c5e1516..7095196 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # jQuery Kendo Message -Simple jQuery plugins that display info and error messages. +A simple jQuery plugin that displays info and error messages. [![Build status](https://ci.appveyor.com/api/projects/status/kls9eyx15a3qtvfs?svg=true)](https://ci.appveyor.com/project/jrummell/kendo-message) @@ -17,4 +17,66 @@ Or install with Bower: > bower install kendo.message -[Usage](https://github.com/jrummell/jquery-message/wiki) +## Usage + +### Options +All options are optional. + +| option | values | default | description | +|--------|--------|---------|-------------| +| message | any text or html | inner html of the matched element | the message | +| type | info, error | info | the type of message | +| dismiss | true, false | true | if true, "Click to dismiss" is appended to the message and clicking it will hide the message | + +### Methods + +| method | arguments | description | +|--------|-----------|-------------| +| show | none | shows the message | +| hide | none | hides the message | +| options | options | changes the options | +| destroy | none | restores the matched element to the state it was in before the message plugin was applied | + +### Examples + + +
Here's an info message.
+
Here's an error message.
+
+
Here's an info message without dismiss.
+
+
Click the following button to change this to an error.
+ +
+
+
Click the following buttons to show or hide.
+ + +
+ +[Demo](http://rawgit.com/jrummell/kendo.message/master/demo/index.html)