summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRob Loach <robloach@gmail.com>2016-06-11 12:05:02 -0400
committerRob Loach <robloach@gmail.com>2016-06-11 12:05:02 -0400
commitc5761787823f0eb0c6b40e38629c14ba536cd305 (patch)
tree9dd800ee781f2aa96b69e6df25651606921aff2c
parent98d808805a71bd3f2d53fa0a73d094a21bb09b0e (diff)
downloadjquery-once-c5761787823f0eb0c6b40e38629c14ba536cd305.zip
jquery-once-c5761787823f0eb0c6b40e38629c14ba536cd305.tar.gz
jquery-once-c5761787823f0eb0c6b40e38629c14ba536cd305.tar.bz2
Update documentation
-rw-r--r--.editorconfig4
-rw-r--r--.gitignore10
-rw-r--r--.travis.yml3
-rw-r--r--API.md5
-rw-r--r--CHANGELOG.md2
-rw-r--r--LICENSE.md2
-rw-r--r--README.md8
-rw-r--r--docker-compose.yml20
-rw-r--r--package.json2
9 files changed, 46 insertions, 10 deletions
diff --git a/.editorconfig b/.editorconfig
index 305e428..aeaa3c4 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -1,5 +1,5 @@
-# v1.3.18 June 8, 2014
-# https://github.com/bevry/base
+# EditorConfig
+# http://editorconfig.org
root = true
[*]
diff --git a/.gitignore b/.gitignore
index e571e42..d4fa57e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,15 @@
+# Gitignore
+# https://git-scm.com/docs/gitignore
+
+# Log files
**/*.log
+
+# Vendor packages
/components
/bower_components
/node_modules
-/coverage
/vendor
/composer.lock
+
+# Code coverage with Istanbul
+/coverage
diff --git a/.travis.yml b/.travis.yml
index fa50290..7f8d7d8 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,9 +1,12 @@
+# Travis CI
+# https://travis-ci.org/RobLoach/jquery-once
language: node_js
sudo: false
node_js:
- "4"
- "5"
+ - "6"
cache:
directories:
diff --git a/API.md b/API.md
index 8b36155..bbfb5c0 100644
--- a/API.md
+++ b/API.md
@@ -1,4 +1,5 @@
## Functions
+
<dl>
<dt><a href="#once">once([id])</a> ⇒</dt>
<dd><p>Filter elements that have yet to be processed by the given data ID.</p>
@@ -10,7 +11,9 @@
<dd><p>Filters elements that have already been processed once.</p>
</dd>
</dl>
+
<a name="once"></a>
+
## once([id]) ⇒
Filter elements that have yet to be processed by the given data ID.
@@ -50,6 +53,7 @@ $('div.calendar').once().each(function () {
});
```
<a name="removeOnce"></a>
+
## removeOnce([id]) ⇒
Removes the once data from elements, based on the given ID.
@@ -76,6 +80,7 @@ $('div.calendar').removeOnce().each(function () {
});
```
<a name="findOnce"></a>
+
## findOnce([id]) ⇒
Filters elements that have already been processed once.
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d271769..d2f0071 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
### Changed
- Updated development dependencies
- Switched from [`semistandard`](https://www.npmjs.com/package/semistandard) to [`xo`](http://npmjs.com/package/xo) for coding standards
+- Updated documentation
+- Tested in [jQuery 3.0](https://blog.jquery.com/2016/06/09/jquery-3-0-final-released/)
## [2.1.1] - August 31st, 2015
### Fixed
diff --git a/LICENSE.md b/LICENSE.md
index 05f6bf2..63d860c 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,6 +1,6 @@
# License
-Copyright &copy; [Rob Loach](http://github.com/RobLoach)
+Copyright &copy; 2016 [Rob Loach](http://github.com/RobLoach)
## GPL-2.0
diff --git a/README.md b/README.md
index 4e8e754..3053f1e 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,8 @@ Method | Installation
[Composer](https://packagist.org/packages/robloach/jquery-once) | `composer require robloach/jquery-once`
[Bower](http://bower.io/search/?q=jquery-once) | `bower install jquery-once`
[Component](https://github.com/componentjs/component) | `component install RobLoach/jquery-once`
-[jsDelivr](http://www.jsdelivr.com/#!jquery.once) | `//cdn.jsdelivr.net/jquery.once/2.0.2/jquery.once.min.js`
-[cdnjs](https://cdnjs.com/libraries/jquery-once) | `//cdnjs.cloudflare.com/ajax/libs/jquery-once/2.0.2/jquery.once.js`
+[jsDelivr](http://www.jsdelivr.com/#!jquery.once) | `//cdn.jsdelivr.net/jquery.once/2.1.1/jquery.once.min.js`
+[cdnjs](https://cdnjs.com/libraries/jquery-once) | `//cdnjs.cloudflare.com/ajax/libs/jquery-once/2.1.1/jquery.once.js`
## Usage
@@ -75,8 +75,8 @@ $('div.calendar').once().each(function() {
6. Tag and publish the new versions to [npm](http://npmjs.com) with [Semantic
Versioning](http://semver.org/):
```
- git tag 2.1.0
- git push origin 2.1.0
+ git tag 2.1.1
+ git push origin 2.1.1
npm publish
```
diff --git a/docker-compose.yml b/docker-compose.yml
index 041073d..fbe0d94 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,6 +1,24 @@
+# Docker Compose - jQuery Once Tester
+# https://docs.docker.com/compose/
+#
+# Runs the jQuery Once test suite through Docker Compose.
+#
+# 1. Install Docker Compose
+#
+# https://docs.docker.com/compose/)
+#
+# 2. Run the following to test jQuery Once:
+#
+# docker-compose up
+#
node:
- image: node:5-slim
+ # Build off of the Node:6 container:
+ # https://hub.docker.com/r/_/node/
+ image: node:6-slim
+ # Run the tests through npm
command: npm test
+ # Mount the current working to /app
volumes:
- .:/app
+ # Start the application in the /app folder
working_dir: /app
diff --git a/package.json b/package.json
index 00b0b99..62d2695 100644
--- a/package.json
+++ b/package.json
@@ -34,7 +34,7 @@
},
"devDependencies": {
"jsdoc-to-markdown": "^1.2.0",
- "jsdom": "~9.1.0",
+ "jsdom": "~9.2.1",
"mocha": "~2.5.1",
"mocha-jsdom": "~1.1.0",
"uglify-js": "~2.6.1",