github.com/bosssauce/ponzu@v0.11.1-0.20200102001432-9bc41b703131/examples/README.md (about)

     1  ## Examples
     2  
     3  Within this directory, you can find a number of different partial examples which
     4  show how to use Ponzu and its features. The goal of this directory is not to host 
     5  full Ponzu projects, but rather just a few files or a package to demonstrate interface 
     6  implementation, using hooks, adding new API endpoints, or creating/using addons.
     7  
     8  For full-project examples, please see the [`ponzu-cms/examples`](https://github.com/ponzu-cms/examples) repo.
     9  
    10  If you are making a contribution to the Ponzu project and are introducing a new
    11  feature, it would be very helpful to include an example with a concrete use-case 
    12  for this directory. 
    13  
    14  ### Table of Contents
    15  1. [Create content via HTTP API using the `api.Createable` interface](https://github.com/ponzu-cms/ponzu/tree/master/examples/createable)
    16  2. [Update content via HTTP API using the `api.Updateable` interface](https://github.com/ponzu-cms/ponzu/tree/master/examples/updateable)
    17  3. [Delete content via HTTP API using the `api.Deleteable` interface](https://github.com/ponzu-cms/ponzu/tree/master/examples/deleteable)