Merge pull request #21 from cirocosta/v0.1.0

V0.1.0

.editorconfig

@@ -3,11 +3,8 @@ root = true
 
 [*]
 indent_size = 2
-indent_style = tab
+indent_style = space
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
-
-[*.js]
-indent_style = space

.gitignore

@@ -1,2 +1,5 @@
-node_modules
-bower_components
+node_modules/
+bower_components/
+.sass-cache/
+
+*.log

.jshintrc

@@ -1,24 +1,18 @@
 {
-  "curly" : true,
-  "eqeqeq" : true,
-  "immed" : true,
-  "latedef" : true,
-  "newcap" : true,
-  "noarg" : true,
-  "sub" : true,
-  "undef" : true,
-  "boss" : true,
-  "eqnull" : true,
-  "node" : true,
-  "globals" : {
-    "window": false,
-    "document": false,
-    "navigator": false,
-    "qrcode": false,
-    "test": false,
-    "ok": false,
-    "asyncTest": false,
-    "expect": false,
-    "MediaStreamTrack": true
-  }
+	"bitwise": false,
+	"curly": false,
+	"freeze": true,
+	"undef": true,
+	"unused": true,
+
+	"laxcomma": true,
+  "expr": true,
+
+	"browser": true,
+	"node": true,
+	"predef": [
+    "qrcode",
+    "MediaStreamTrack",
+    "define"
+  ]
 }

.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - '0.10'
+env:
+  global:
+  - secure: k++7lCMP9FL3XVMI/VbKDsQB2wxoUq944WeuKcBS4+iHFaDiO1Bu0LZV6VIcWc+5xwvpgLQmjEK0ksW3lHiQ703PCZ9A2IJn6Nic9iiN55U7AnNsTRxKgD1U7GbO8w/21B81TXATNlEsf/azsE80wCVurcSENp53q4bBfwZyxuU=
+  - secure: LegkxjHVLvk1tnOqeknBgKjPlkbLZn1k8xAQMjeZzOl9jhTSJMtPgud+KqRtOLHYQBWGpBidUHaYy7VBVBjP0bldD6C0gco1swT09QIRh0A5BZY3ePOWAvq1J2yutGEiFvOdRjXeIv2bPphPEhy2W78c6Kl+kJqX+ge7iel0YMk=

.zuul.yml

@@ -0,0 +1,12 @@
+ui: mocha-bdd
+browsers:
+  - name: chrome
+    version: latest
+  - name: firefox
+    version: 27..latest
+  - name: ie
+    version: 9..latest
+  - name: iphone
+    version: 6.1..latest
+  - name: android
+    version: 4.0..latest

README.md

@@ -1,6 +1,8 @@
 # qcode-decoder
 
-> Decodes QRCode in the browser / node
+> Decodes QRCode in the browser
+
+[![Sauce Test Status](https://saucelabs.com/browser-matrix/cirocosta_github.svg)](https://saucelabs.com/u/cirocosta_github)
 
 ## Using in your project
 
@@ -10,7 +12,7 @@ Download it as a dependency
 $ bower install qcode-decoder
 ```
 
-attach it to your html file
+attach it to your `.html` file
 
 ```html
 <script src="../bower_components/qcode-decoder/build/qcode-decoder.min.js"></script>
@@ -20,14 +22,68 @@ and use it!
 
 **For a full example, see `/examples` or [this plunkr](http://plnkr.co/aWikiL)**
 
+The API is Pretty simple:
+
+### QCodeDecoder()
+Constructor. No args. Might be create with or without `new`.
+
+```javascript
+var qr = new QCodeDecoder();
+// or
+var qr = QCodeDecoder();
+```
+
+This construction lets us be able to chain some methods (although not very necessary - the API is **really** simple).
+
+#### ::decodeFromImage(img)
+
+Decodes an image from a source provided or an `<img>` element with a `src` attribute set.
+
+```javascript
+qr.decodeFromImage(img, function (err, result) {
+  if (err) throw err;
+
+  alert(result);
+});
+```
+
+#### ::decodeFromVideo(videoElem, cb, [,once])
+Decodes directly from a video with a well specified `src` attribute
+
+```javascript
+QCodeDecoder()
+  .decodeFromVideo(document.querySelector('video'), function (err, result) {
+    if (err) throw err;
+
+    alert(result);
+  }, true);
+```
+
+
+#### ::decodeFromCamera(videoElem, cb, [,once])
+Decodes from a videoElement. The optional argument **once** makes the *QCodeDecoder* to only find a QRCode once.
+
+```javascript
+qr.decodeFromCamera(videoElem, function (err) {
+  if (err) throw err;
+
+  alert(result);
+});
+```
+
+#### ::stop()
+
+Stops the current `qr` from searching for a QRCode.
+
+
 ## Messing around
 
-For messing around w/ this module and making the example alive, run `npm run start-server` and then go to `http://localhost:8080/examples`
+The proper use of camera APIs and, then, the use of this module, the developer needs to first initiate a webserver for running the examples. I suggest going with [http-server](https://github.com/nodeapps/http-server).
 
 ## Credits
 
 The main decoder methods are from [Lazar Laszlo](http://www.
-lazarsoft.info/). Go check his work!
+lazarsoft.info/), who ported ZXing lib (Apache V2) to JavaScript.
 
 ## LICENSE
 

bower.json

@@ -2,7 +2,7 @@
   "name": "qcode-decoder",
   "main": "build/main.min.js",
   "description": "Decodes QRCode in the browser and node",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "homepage": "https://github.com/cirocosta/qcode-decoder",
   "authors": [
     "Ciro S. Costa <ciro.costa@usp.br>"