From 7641f7cf17fe9e729e013be71f3ffd7e7af5aaf1 Mon Sep 17 00:00:00 2001 From: Jesse Hallam Date: Tue, 24 Jul 2018 15:45:28 -0400 Subject: [PATCH] update README.md, description to reflect sample nature of repository --- README.md | 9 +-------- plugin.json | 18 ++---------------- 2 files changed, 3 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 84b8622..5620d97 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # Sample Plugin -This plugin serves as a reference guide for best practices, build scripts and samples when writing Mattermost plugins. It also doubles as a testbed for verifying plugin functionality during release testing. See [server/README.md](server/README.md) and [webapp/README.md](webapp/README.md) for more details. - -The example implementations are primarily meant as illustrations to assist with developing your plugin. Feel free to base your own plugin off this repository, removing or modifying components as needed. +This plugin serves as a starting point for writing a Mattermost plugin. Feel free to base your own plugin off this repository. ## Getting Started Shallow clone the repository to a directory matching your plugin name: @@ -47,8 +45,3 @@ In production, deploy and upload your plugin via the [System Console](https://ab ### How do I make a server-only or web app-only plugin? Simply delete the `server` or `webapp` folders and remove the corresponding sections from `plugin.json`. The build scripts will skip the missing portions automatically. - -### How do I remove unwanted hooks from the server? - -Simply delete the corresponding implementations (or files). The Mattermost server automatically -identifies which hooks have been implemented when the plugin is started. diff --git a/plugin.json b/plugin.json index 40199cd..d4790b5 100644 --- a/plugin.json +++ b/plugin.json @@ -1,7 +1,7 @@ { "id": "com.mattermost.sample-plugin", "name": "Sample Plugin", - "description": "This plugin serves as a reference guide for best practices and build scripts when writing Mattermost plugins.", + "description": "This plugin serves as a starting point for writing a Mattermost plugin.", "version": "0.0.1", "server": { "executables": { @@ -17,20 +17,6 @@ "settings_schema": { "header": "", "footer": "", - "settings": [{ - "key": "ChannelName", - "display_name": "Channel Name", - "type": "text", - "help_text": "The channel to use as part of the sample plugin, created for each team automatically if it does not exist.", - "placeholder": "sample_plugin", - "default": "sample_plugin" - }, { - "key": "Username", - "display_name": "Username", - "type": "text", - "help_text": "The user to use as part of the sample plugin, created automatically if it does not exist.", - "placeholder": "sample_plugin", - "default": "sample_plugin" - }] + "settings": [] } }