diff --git a/.bowerrc b/.bowerrc deleted file mode 100644 index c815cd5..0000000 --- a/.bowerrc +++ /dev/null @@ -1,4 +0,0 @@ -{ - "directory": "bower_components/", - "interactive": false -} \ No newline at end of file diff --git a/.jscsrc b/.jscsrc deleted file mode 100644 index eb82d31..0000000 --- a/.jscsrc +++ /dev/null @@ -1,20 +0,0 @@ -{ - "requireCurlyBraces": ["if", "else", "for", "while", "do", "try", "catch"], - "requireSpaceAfterKeywords": ["if", "else", "for", "while", "do", "switch", "return", "try", "catch"], - "disallowSpaceBeforeBinaryOperators": [",", ":"], - "disallowSpaceAfterBinaryOperators": ["!"], - "requireSpaceBeforeBinaryOperators": ["?", "+", "-", "/", "*", "=", "==", "===", "!=", "!==", ">", ">=", "<", "<="], - "requireSpaceAfterBinaryOperators": ["?", "+", "/", "*", ":", "=", "==", "===", "!=", "!==", ">", ">=", "<", "<="], - "disallowImplicitTypeConversion": ["string"], - "disallowKeywords": ["with"], - "disallowMultipleLineBreaks": true, - "disallowKeywordsOnNewLine": ["else"], - "disallowTrailingWhitespace": true, - "requireLineFeedAtFileEnd": true, - "validateIndentation": 4, - "validateQuoteMarks": "'", - "validateJSDoc": { - "checkParamNames": true, - "requireParamTypes": true - } -} diff --git a/README.md b/README.md index a847e3c..e254e8e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,31 @@ I'm using the [Vectorized Playing Cards 1.3](http://code.google.com/p/vectorized The [change log](https://github.com/richardschneider/cardsJS/releases) is automatically produced with the help of [semantic-release](https://github.com/semantic-release/semantic-release). +## Getting started + +**cardsJS** is available for [Node.js](https://nodejs.org) and most modern browsers. If you want to know if your currrent browser is compatible, run the [online test suite](https://unpkg.com/table-master-parser/test/index.html). + +Install with [npm](http://blog.npmjs.org/post/85484771375/how-to-install-npm) + + > npm install cardsJS --save + + +### Browser + +Include the package from your project + +````html + + +```` + +or from the [unpkg CDN](https://unpkg.com) + +````html + + +```` + ## Cards Use the `` HTML tag; where *id* is the identifier of the card. The *id* is composed of the rank and then the suit of the card, diff --git a/bower.json b/bower.json deleted file mode 100644 index 7f03b57..0000000 --- a/bower.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "name": "cardsJS", - "version": "0.0.7", - "homepage": "http://richardschneider.github.io/cardsJS/", - "authors": [ - "Richard Schneider " - ], - "description": "Scalable playing cards with various hand layouts.", - "moduleType": [ - "amd", - "globals", - "node" - ], - "keywords": [ - "bridge", - "playing", - "cards", - "svg" - ], - "main": "cards.js", - "license": "MIT", - "ignore": [ - "**/.*", - "node_modules", - "bower_components", - "test", - "index.html", - "site", - "sync.cmd", - "gulpfile.js", - "brackets.json" - ], - "dependencies": { - "knockout": "~3.3.0", - "jquery": "~2.1.3" - } -}