diff options
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..9789cab --- /dev/null +++ b/examples/README.md @@ -0,0 +1,14 @@ +## Examples + +Within this directory, you can find a number of different examples of how to use +Ponzu and its features. The goal of this directory is not to host full Ponzu +projects, but rather just a few files or a package to demonstrate interface +implementation, using hooks, adding new API endpoints, or creating/using addons. + +If you are making a contribution to the Ponzu project and are introducing a new +feature, it would be very helpful to include an example with a concrete use-case +for this directory. + +### Table of Contents +1. [Add content via HTTP API using the `api.Externalable` interface](https://github.com/ponzu-cms/ponzu/tree/master/content/externalable) + |