flex-plugin - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

package.json

 {
   "name": "flex-plugin",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Runtime for Flex Plugins",
@@ -10,4 +10,4 @@ "keywords": [
   "author": "Dominik Kundel <[e-mail]>",
-  "homepage": "",
-  "license": "ISC",
+  "homepage": "https://github.com/twilio/flex-plugin-builder",
+  "license": "MIT",
   "main": "dist/flex-plugin.js",
@@ -33,3 +33,3 @@ "directories": {
   },
-  "gitHead": "aab2e10744902998d4cba38680ef8d134fe888d0"
+  "gitHead": "990196b256560cf5315400f38cfd3d7fc8f06e56"
 }

README.md

@@ -1,11 +0,56 @@
-# `@twilio/flex-plugin`
+![npm](https://img.shields.io/npm/v/flex-plugin.svg?style=flat-square)
+![npm](https://img.shields.io/npm/dt/flex-plugin.svg?style=flat-square)
+[![NpmLicense](https://img.shields.io/npm/l/flex-plugin.svg?style=flat-square)](LICENSE.md)
 
-> TODO: description
+# `flex-plugin`
 
+Library to help building [Twilio Flex](https://www.twilio.com/flex) Plugins.
+
+## Installation
+
+```bash
+npm install flex-plugin
+```
+
 ## Usage
 
+```js
+import { loadPlugin, FlexPlugin } from 'flex-plugin';
+
+class MyPlugin extends FlexPlugin {
+  pluginName = 'MyPlugin';
+
+  init(flex, manager) {
+    // setup your flex
+    flex.TaskCanvas.Content.add(<p>Hello</p>);
+  }
+}
+
+loadPlugin(MyPlugin);
 ```
-import flexPlugin from '@twilio/flex-plugin';
 
-// TODO: DEMONSTRATE API
+## Contributing
+
+Make sure to follow the instructions in the [main repository](https://github.com/twilio/flex-plugin-builder#contributing) to setup the project
+
+```bash
+# Install dependencies and link local packages with each other
+cd packages/flex-plugin
+npx lerna bootstrap
+
+# Run tests
+npm test
+
+# To use your local package in a different project
+npm link
+# then in a different project
+npm link flex-plugin
 ```
+
+## Contributors
+
+Thank you to all the lovely contributors to this project. Please check the main repository to see [all contributors](https://github.com/twilio/flex-plugin-builder#contributors).
+
+## License
+
+MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5707

increased by66.09%

Number of package files

9

increased by12.5%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

57

increased by375%

No dependency changes