Enhancement: Add documentation on using the Example project(s) - Githubissues

SkywardApps / popcorn

Popcorn is a .Net Middleware for your RESTful API that allows your consumers to request exactly as much or as little as they need, with no effort from you.

https://skywardapps.github.io/popcorn/

MIT License

59 stars 19 forks source link

Enhancement: Add documentation on using the Example project(s) #39

Closed GeoffMartinSkyward closed 6 years ago

GeoffMartinSkyward commented 6 years ago

Issue tracker is ONLY used for reporting bugs. NO NEW FEATURE ACCEPTED! Use stackoverflow for supporting issues.

Currently there is no documentation for the example project.

It is not obvious that the project will run and the endpoints accessed though curl/postman/etc type http request tools.

Possible Solution

Write up a how to for using the example project.

Expected Behavior

Users can jump into the example and try out popcorn easily.

Possible Implementation

Add an md file for the user to explore.