From bf81278403e73055fa510e12e5605e561a7f67ba Mon Sep 17 00:00:00 2001 From: carl sednaoui Date: Mon, 12 May 2014 23:17:45 -0400 Subject: [PATCH] Add sitewide-cookie documentation to README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2feacc3..d239fe1 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,8 @@ OuiBounce offers a few options, such as: - [Timer](#set-a-min-time-before-ouibounce-fires) - [Callback](#callback) - [Cookie expiration](#cookie-expiration) +- [Sitewide cookie](#sitewide-cookie) +- [Chaining options](#chaining-options) ##### Sensitivity Define how far the mouse has to be from the window breakpoint. The higher value, the more sensitive, and the more quickly the event will fire. _Defaults to 20._ @@ -107,12 +109,22 @@ _Example:_ ouibounce(document.getElementById('ouibounce-modal'), { cookieExpire: 10 }); ``` -__Multiple options:__ The options are just a javascript object, so if you want, you can also combine multiple options. +##### Sitewide cookie +You can drop sitewide cookies by using this option. + +_Example:_ +```js +ouibounce(document.getElementById('ouibounce-modal'), { sitewide: true }); +``` + +##### Chaining options +The options are just javascript objects, you can therefore combine multiple options. _Example:_ ```js ouibounce(document.getElementById('ouibounce-modal'), { aggressive: true, + sitewide: true, timer: 0, callback: function() { console.log('ouibounce fired!'); } });