Skip to content

Commit

Permalink
update main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sylviamoss committed Feb 24, 2021
1 parent 3bb73cd commit 56f8922
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Packer Plugin Scaffolding

This repository is a template for a Packer multi-component plugin. It is intended as a starting point for creating Packer plugins, containing:
- A builder (`builder/scaffolding`)
- A provisioner (`provisioner/scaffolding`)
- A post-processor (`post-processor/scaffolding`)
- A data source (`datasource/scaffolding`)
- Docs (`docs/`)
- A builder ([builder/scaffolding](builder/scaffolding))
- A provisioner ([provisioner/scaffolding](provisioner/scaffolding))
- A post-processor ([post-processor/scaffolding](provisioner/scaffolding))
- A data source ([datasource/scaffolding](datasource/scaffolding))
- Docs ([docs](docs))
- A working example ([example](example))

These folders contain boilerplate code that you will need to edit to create your own Packer multi-component plugin.
A full guide to creating Packer plugins can be found at [Extending Packer](https://www.packer.io/docs/plugins/creation).
Expand Down
2 changes: 1 addition & 1 deletion example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## The Example Folder

This folder must contain a fully working example for the plugin. The example must define the `required_plugins` block.
This folder must contain a fully working example of the plugin usage. The example must define the `required_plugins` block.
A pre-defined GitHub Action will run `packer init` and `packer build` against it and test your plugin with
the latest version available of Packer.

Expand Down

0 comments on commit 56f8922

Please sign in to comment.