From 769214cb2a234968fd2e76391fdcebb179cfddab Mon Sep 17 00:00:00 2001 From: Piotr Grzesik Date: Thu, 11 Feb 2021 19:10:20 +0100 Subject: [PATCH] feat(Templates): Add a simple README for `plugin` template --- lib/plugins/create/templates/plugin/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 lib/plugins/create/templates/plugin/README.md diff --git a/lib/plugins/create/templates/plugin/README.md b/lib/plugins/create/templates/plugin/README.md new file mode 100644 index 000000000..6f17c4699 --- /dev/null +++ b/lib/plugins/create/templates/plugin/README.md @@ -0,0 +1,15 @@ +# Serverless Plugin + +This plugin has been generated using the `plugin` template from the [Serverless Framework](https://www.serverless.com/). + +## Implementing your plugin + +When developing your plugin, please refer to the following sources: + +- [Plugins Documentation](https://www.serverless.com/framework/docs/providers/aws/guide/plugins/) +- [Blog - How to create serverless plugins - Part 1](https://serverless.com/blog/writing-serverless-plugins/) +- [Blog - How to create serverless plugins - Part 2](https://serverless.com/blog/writing-serverless-plugins-2/) + +## Sharing your plugin + +After implementing your plugin, you might consider sharing it with a wider audience. You might do it by adding it to `Community Contributed Plugins` in official [plugins repository](https://github.com/serverless/plugins).