@abtasty/widget-quality 0.0.6 → 0.1.0

package/README.md

@@ -0,0 +1,31 @@
+# AB-tasty Widget-Quality
+
+This widget was generated using AB Tasty Widget CLI. You can find more infomation and documentation about widgets at https://abtasty.gitbooks.io/widget/.
+
+## Preview your widget
+
+Launch your widget in a new window and watch for changes.
+```bash
+npm start
+```
+
+## Main files
+
+* `main.js`
+Main source code of your widget
+* `form.js`
+Configuration form for your widget
+
+You can specify each file location in the `package.json` like this:
+```json
+  "main": "dist/main.js",
+  "form": "dist/form.js",
+```
+
+## Add your widget to AB Tasty
+
+1. First, you'll need to have your widget on NPM:
+    * Create a minified bundle with `npm run build`
+    * Bump the version of your widget ([using semver](http://semver.org/)) with `npm version [patch|minor|major]`
+    * Publish it to NPM: `npm publish`
+2. Once your widget is on NPM, you can now add it on AB Tasty at https://marketplace.abtasty.com/publish.