-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
51 lines (39 loc) · 1.73 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
jQuery plugin to the forrst.com API
Allows for retrieval of user info, post info and soon authentication. Also
supports AES encryption for client storage and more...
Fork me @ https://www.github.com/jas-/jQuery.forrst
REQUIREMENTS:
* jQuery libraries (required - http://www.jquery.com)
* pidCrypt RSA & AES libraries (required - https://www.pidder.com/pidcrypt/)
* jQuery cookie plugin (optional - http://plugins.jquery.com/files/jquery.cookie.js.txt)
FEATURES:
1. Interface for authentication
2. Interface for user information
3. Interface for post information
4. Caching support for response
* HTML5 localStorage support
* HTML5 sessionStorage support
* Cookie support
* Optional AES encryption support for client storage
OPTIONS:
* storage: HTML5 localStorage, sessionStorage and cookies supported
* aes: Options Gibberish-AES encryption support
* callback: Optional function used once server recieves encrypted data
EXAMPLES;
* Authentication example (for use on a form)
$('#formID').forrst('authenticate');
* Get user information (for use on a form)
$('#formID').forrst('userinfo');
* Get user information (with name specified)
$('#formID').forrst('userinfo',{id:'username'});
* Get user information (with name specified)
using encryption to store results (requires GibberishAES library)
$('#formID').forrst('userinfo',{id:'username',aes:true});
* Get user information (with name specified)
using sessionStorage
$('#formID').forrst('userinfo',{id:'username',storage:'sessionStorage'});
* Get user information (with name specified)
using cookies (requires cookie plugin)
$('#formID').forrst('userinfo',{id:'username',storage:'cookie'});
Author: Jason Gerfen <jason.gerfen@gmail.com>
License: GPL