Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update readme

  • Loading branch information...
commit 79a53b75819978dd3c744774b77f6f44854a88d6 1 parent 68c683b
@harborhoffer harborhoffer authored
Showing with 14 additions and 14 deletions.
  1. +10 −10 README.md
  2. +4 −4 jquery.callme.js
View
20 README.md
@@ -1,15 +1,17 @@
-jQuery plugin that makes it easy to drop a phone directly into any webpage with just a few lines of code.
+A jQuery plugin and [Phono](http://www.phono.com) add-on that makes it easy to drop a callme button directly into any webpage with just a few lines of code.
### Requires:
* [Phono jQuery Plugin](http://www.phono.com)
* Phono API Key. [Get one here](http://www.phono.com)
- * [jQuery UI Theme](http://jqueryui.com/themeroller/) - *For phone styling*
+
+### Themeing/Styling
+The callme plugin uses the [jQuery UI theme classes](http://jqueryui.com/themeroller/) for styling the callme button and dialpad etc.
### Example:
$("body").append(
$("<div/>")
.css({"width":"220px"})
- .phone({
+ .callme({
apiKey: "C17D167F-09C6-4E4C-A3DD-2025D48BA243",
numberToDial: "8007773456",
buttonTextReady: "1-800-FILM (Moviefone)",
@@ -18,19 +20,17 @@ jQuery plugin that makes it easy to drop a phone directly into any webpage with
)
### Options:
- * **apiKey**: String, your Phono.com api key. Get one [here](http://http://www.phono.com/)
- * **dialPad**: Boolean, defaults to true. Include a dial pad in the phone
+ * **apiKey**: String, your Phono.com api key. Get one [here](http://www.phono.com/)
+ * **dialPad**: Boolean, defaults to true. Include a dial pad
* **toggleMic**: Boolean, defaults to true. Show a checkbox where users can specify whether or not they are wearing a headset
* **slideOpen**: Boolean, defaults to true. Slide open the dial pad and mic toggle when the call button is clicked
* **buttonText**: String, defaults to "loading...". Text to display in the call button while the phone is loading
- * **buttonTextReady**: String, defaults to "Call me". Text to display in the call button when the phone is ready
+ * **buttonTextReady**: String, defaults to "Call me". Text to display in the call button when the "phone" is ready
* **numberToDial**: String, defaults to a demo IVR application hosted at [tropo.com](http://www.tropo.com).
Set this to the phone number, [Tropo](http://www.tropo.com) appid, or sip number you want to call
### Demo:
-[http://s.phono.com/releases/0.2/samples/phone/index.htm](http://s.phono.com/releases/0.2/samples/phone/index.htm).
+[http://s.phono.com/releases/0.2/samples/callme/index.htm](http://s.phono.com/releases/0.2/samples/callme/index.htm).
### Contact:
-[Twitter](http://www.twitter.com/phonosdk)
-
-[http://www.phono.com](http://www.phono.com)
View
8 jquery.callme.js
@@ -1,8 +1,8 @@
(function( $ ){
- $.fn.phone = function( options ) {
+ $.fn.callme = function( options ) {
- var thisPhone = this, dispatcher = $({}), phonoOptions = {}, phono, call;
+ var thisPhone = this, dispatcher = $({}), callMeOptions = {}, phono, call;
var settings = {
apikey : "",
dialpad: true,
@@ -16,14 +16,14 @@
if(options) {
//lowercase all options passed in
$.each(options, function(k,v){
- phonoOptions[k.toLowerCase()] = v;
+ callMeOptions[k.toLowerCase()] = v;
});
}
return this.each(function(){
if ( options ) {
- $.extend( settings, phonoOptions );
+ $.extend( settings, callMeOptions );
}
var phone = buildPhone( settings );
Please sign in to comment.
Something went wrong with that request. Please try again.