summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorSteve Manuel <nilslice@gmail.com>2017-04-17 11:26:33 -0700
committerSteve Manuel <nilslice@gmail.com>2017-04-17 11:26:33 -0700
commit9e3261c9c07e1cba7ae9a5b711fd0f35911b7319 (patch)
treeff060f6e93c226e1d027b0617c7f388d0620282f /examples
parent8ef6650b7b8a5ced7f2b40e350475345ca5b19d0 (diff)
adding link to ponzu-cms/examples repo
Diffstat (limited to 'examples')
-rw-r--r--examples/README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/examples/README.md b/examples/README.md
index 4e62bf8..dd11493 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,10 +1,12 @@
## 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
+Within this directory, you can find a number of different partial examples which
+show 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.
+For full-project examples, please see the [`ponzu-cms/examples`](https://github.com/ponzu-cms/examples) repo.
+
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.