-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
James Watts
committed
Jun 28, 2015
1 parent
84f0401
commit 3517284
Showing
1 changed file
with
55 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,55 @@ | ||
| # nano-cookie | ||
| cookie plugin for the nano JavaScript framework | ||
| nano Cookie plugin | ||
| ================== | ||
|
|
||
| The **Cookie** plugin for the [nano JavaScript framework](http://nanojs.org) adds 2 methods to easily read and write to cookies. | ||
|
|
||
| Installation | ||
| ------------ | ||
|
|
||
| To add the **Cookie** plugin include it in the `<head>` of the document, after the core framework: | ||
|
|
||
| ```html | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>My Site</title> | ||
| <script src="path/to/nano.js"></script> | ||
| <script src="path/to/nano.cookie.js"></script> | ||
| </head> | ||
| <body> | ||
|
|
||
| <!-- your content here --> | ||
|
|
||
| </body> | ||
| </html> | ||
| ``` | ||
|
|
||
| Documentation | ||
| ------------- | ||
|
|
||
| Full documentation for the plugin is available at [http://nanojs.org/plugins/cookie](http://nanojs.org/plugins/cookie). | ||
|
|
||
| Support | ||
| ------- | ||
|
|
||
| For support, bugs and feature requests, please use the [issues](https://github.com/nanojs/nano-cookie/issues) section of this repository. | ||
|
|
||
| Contributing | ||
| ------------ | ||
|
|
||
| If you'd like to contribute new features, enhancements or bug fixes to the code base just follow these steps: | ||
|
|
||
| * Create a [GitHub](https://github.com/signup/free) account, if you don't own one already | ||
| * Then, [fork](https://help.github.com/articles/fork-a-repo) the [nano-cookie](https://github.com/nanojs/nano-cookie) repository to your account | ||
| * Create a new [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository) from the *develop* branch in your forked repository | ||
| * Modify the existing code, or add new code to your branch | ||
| * When ready, make a [pull request](http://help.github.com/send-pull-requests/) to the main repository | ||
|
|
||
| There may be some discussion regarding your contribution to the repository before any code is merged in, so be prepared to provide feedback on your contribution if required. | ||
|
|
||
| License | ||
| ------- | ||
|
|
||
| Copyright 2008-2015 James Watts. All rights reserved. | ||
|
|
||
| Licensed under the GNU/GPL. Redistributions of the source code included in this repository must retain the copyright notice found in each file. |