Add a plugin example for creating custom types and fix grammar errors…

… in the documentation

Signed-off-by: Axel Boberg <[email protected]>

docs/README.md

@@ -1,6 +1,6 @@
 # Full documentation
 
-Welcome to the full documentation for Bridge. Whether you're want to build your own extension or are looking for more information about the internals, this is the place to find it.
+Welcome to the full documentation for Bridge. Whether you want to build your own extension or are looking for more information about the internals, this is the place to find it.
 
 ## Bundled plugins
 - [Inspector](/plugins/inspector/README.md)
@@ -12,6 +12,7 @@ Welcome to the full documentation for Bridge. Whether you're want to build your
 
 ## Developing plugins
 - [Guide](/docs/plugins/README.md)
+- [Examples](/examples)
 - [API reference](/docs/api/README.md)
 
 ## Internals

examples/plugin-custom-types/README.md

@@ -0,0 +1,3 @@
+# Custom types example plugin
+This is an example plugin for showcasing how to create custom types that can be run within Bridge.
+The type definition is located within [package.json](./package.json) while the type-specific logic resides in [index.js](./index.js).

examples/plugin-custom-types/index.js

@@ -0,0 +1,29 @@
+const bridge = require('bridge')
+
+/*
+The exported 'activate' function is the plugin's initialization function,
+it will be called when the plugin is loaded and every time a workspace
+is opened
+*/
+exports.activate = async () => {
+  /*
+  Listen for the item.play event to react to an item being played,
+  the item's type-property can be used to perform the correct action
+
+  The type 'plugin-custom-types.my-type' is in this case
+  defined within the plugin's package.json file
+  */
+  bridge.events.on('item.play', item => {
+    if (item?.type === 'plugin-custom-types.my-type') {
+      // Perform action
+      console.log('MY CUSTOM TYPE PLAYED')
+    }
+  })
+
+  bridge.events.on('item.stop', item => {
+    if (item?.type === 'plugin-custom-types.my-type') {
+      // Perform action
+      console.log('MY CUSTOM TYPE STOPPED')
+    }
+  })
+}

examples/plugin-custom-types/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "plugin-custom-types",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "engines": {
+    "bridge": "^0.0.1"
+  },
+  "author": "",
+  "license": "ISC",
+  "contributes": {
+    "types": [
+      {
+        "id": "plugin-custom-types.my-type",
+        "name": "My custom type",
+        "inherits": "bridge.types.delayable",
+        "category": "Custom types",
+        "properties": {
+          "myValue": {
+            "name": "My custom value",
+            "type": "string",
+            "default": "Default value",
+            "ui.group": "My custom type plugin"
+          }
+        }
+      }
+    ]
+  }
+}