fmartingr/mattermost-plugin-attachments-remover
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README.md, description to reflect sample nature of repository

Browse source
This commit is contained in:
Jesse Hallam 2018-07-24 15:45:28 -04:00
parent 390fab485d
commit 7641f7cf17
No known key found for this signature in database
GPG key ID: E7959EB6518AF966
2 changed files with 3 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,8 +1,6 @@
# Sample Plugin # 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. This plugin serves as a starting point for writing a Mattermost plugin. Feel free to base your own plugin off this repository.
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.
## Getting Started ## Getting Started
Shallow clone the repository to a directory matching your plugin name: 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? ### 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. 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.

18
plugin.json
View file

@ -1,7 +1,7 @@
{ {
"id": "com.mattermost.sample-plugin", "id": "com.mattermost.sample-plugin",
"name": "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", "version": "0.0.1",
"server": { "server": {
"executables": { "executables": {
@ -17,20 +17,6 @@
"settings_schema": { "settings_schema": {
"header": "", "header": "",
"footer": "", "footer": "",
"settings": [{ "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"
}]
} }
} }