Permalink
Browse files

- update doc

  • Loading branch information...
guillaumepotier committed Dec 9, 2017
2 parents 981d08d + 3979424 commit b76a034c50dd94942f8d4a7b0d4bce2f19938285
Showing with 9,752 additions and 6,656 deletions.
  1. +2 −0 .gitignore
  2. +1 −6 .travis.yml
  3. +5 −1 CHANGELOG.md
  4. +9 −0 CONTRIBUTE.md
  5. +11 −20 README.md
  6. +0 −15 bin/build.sh
  7. +0 −39 bin/minify
  8. +1 −1 bin/test-suite.sh
  9. +7 −6 component.json
  10. +0 −46 dist/garlic-standalone.min.js
  11. +2 −13 dist/garlic.min.js
  12. +20 −6 garlic.js
  13. +5 −8 index.html
  14. +30 −0 package.json
  15. +6,167 −0 resources/bootstrap-2.3.2.css
  16. +1,143 −0 resources/docs.css
  17. +0 −1,253 tests/expect.js
  18. +7 −2 tests/index.html
  19. +0 −227 tests/mocha.css
  20. +0 −5,002 tests/mocha.js
  21. +36 −11 tests/tests.js
  22. +18 −0 webpack.config.js
  23. +2,288 −0 yarn.lock
View
@@ -1 +1,3 @@
.DS_Store
+/node_modules
+/bower_components
View
@@ -1,9 +1,4 @@
language: node_js
node_js:
- - 0.6
-
-before_script:
- - npm install -g mocha-phantomjs@v2.0.3
-
-script: ./bin/test-suite.sh
+ - "0.10"
View
@@ -1,4 +1,8 @@
-#Changelog
+# Changelog
+
+* **1.2.4** :
+
+ - loosen jquery dependency (#81)
* **1.2.3** :
View
@@ -0,0 +1,9 @@
+# Contribute!
+
+* fork repository
+* `npm install`
+* add your changes to garlic.js
+* add / update tests to test suite (tests/index.html / tests/tests.js)
+* run tests (`npm test`)
+* create new minified versions with minify script (see above)
+* make a Pull Request!
View
@@ -1,40 +1,40 @@
-#Garlic.js
+# Garlic.js
[![Build Status](https://secure.travis-ci.org/guillaumepotier/Garlic.js.png?branch=master)](https://travis-ci.org/guillaumepotier/Garlic.js)
Garlic.js allows you to automatically persist your forms' text and select field values locally, until the form is submitted. This way, your users don't lose any precious data if they accidentally close their tab or browser.
-#Demonstration / Documentation
+# Demonstration / Documentation
http://garlicjs.org/
-#Version
+# Version
-1.2.3
+1.4.0
See CHANGELOG for more info.
-#TODO
+# TODO
* Improve doc and api;
* Refactorize some code;
* Work on inputs radio and textarea where there are conflicts;
* And much more, for fun!
-#Run tests
+# Run tests
* In your browser: go to `tests/index.html`
-* Headless tests: install mocha-phantomjs with npm: `npm install -g mocha-phantomjs` and then run `./bin/test-suite.sh`
+* Headless tests: `npm install && npm test`
-#Make production minified versions
+# Make production minified versions
You'll need ruby, and Google Closure compiler: `gem install closure-compiler`. Then, just call:
`./bin/build.sh version` where version is the build release. eg: `./bin/build.sh 1.1.2`
They'll be created and dumped in the dist/ directory
-#Contributors
+# Contributors
* @cdmoyer
* @johnrees
@@ -43,20 +43,11 @@ They'll be created and dumped in the dist/ directory
* @willdurand
* @nashby
-#Contribute!
-
-* fork repository
-* add your changes to garlic.js
-* add / update tests to test suite (tests/index.html / tests/tests.js)
-* run tests (see above)
-* create new minified versions with minify script (see above)
-* make a Pull Request!
-
-#Used / Inspiration
+# Used / Inspiration
* localStorageshim for IE browsers: https://github.com/mattpowell/localstorageshim by @mattpowell
* minify ruby script https://gist.github.com/765432 by @benpickles
-#Licence
+# Licence
MIT - See LICENCE.md
View
@@ -1,15 +0,0 @@
-#!/usr/bin/env bash
-
-if [[ -z "$1" ]]
-then
-echo "You must give a version number. eg: ./bin/build.sh 1.0.0"
-
-else
-echo "** building garlic.min.js version " $1
-ruby ./bin/minify garlic.js dist/garlic.min.js $1 --force
-echo " done!"
-
-echo "** building garlic-standalone.min.js version " $1
-ruby ./bin/minify resources/zepto-1.0rc1[zepto.event.data].min.js garlic.js dist/garlic-standalone.min.js $1 --force
-echo " done!"
-fi
View
@@ -1,39 +0,0 @@
-#!/usr/bin/env ruby
-
-# heavily inspired by https://gist.github.com/765432 :)
-
-dry_run = ARGV.delete('--dry-run')
-force = ARGV.delete('--force')
-
-input, output, garlic_version = ARGV.length == 1 ?
- [ARGV, ARGV.first.sub(/\.js$/, '.min.js'), 'x.x.x'] :
- [ARGV[0..-3], ARGV.at(-2), ARGV.last]
-
-if (missing = input.select { |path| !File.exists?(path) }).any?
- puts "Some input files do not exist:\n #{missing.join(" \n")}"
- exit 1
-end
-
-if File.exists?(output) && !force
- puts "Output file #{output} already exists, use the --force to overwrite"
- exit 1
-end
-
-if dry_run
- puts "#{input.inspect} => #{output}"
-else
- require 'rubygems'
-
- begin
- require 'closure-compiler'
- rescue LoadError
- puts "Error loading Closure Compiler gem:\n gem install closure-compiler"
- exit 1
- end
-
- File.open(output, 'w') do |f|
- f.write "/* Garlicjs %s build version %s http://garlicjs.org */\n" %
- [output, garlic_version]
- f.write Closure::Compiler.new.compile_files(input)
- end
-end
View
@@ -1,3 +1,3 @@
#!/usr/bin/env bash
-mocha-phantomjs tests/index.html && mocha-phantomjs tests/index.html#jquery-min && mocha-phantomjs tests/index.html#zepto && mocha-phantomjs tests/index.html#zepto-min && mocha-phantomjs tests/index.html#standalone
+mocha-phantomjs tests/index.html && mocha-phantomjs tests/index.html#jquery-min
View
@@ -1,8 +1,9 @@
{
- "name": "garlicjs",
- "version": "1.2.1",
- "main": "./dist/garlic.min.js",
- "dependencies": {
- "jquery": "1.8.*"
- }
+ "name": "garlicjs",
+ "version": "1.2.4",
+ "main": "./dist/garlic.min.js",
+ "dependencies": {
+ "jquery": "*",
+ "bootstrap": "^3.3.7"
+ }
}
Oops, something went wrong.

0 comments on commit b76a034

Please sign in to comment.