Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 634 Bytes

examples.md

File metadata and controls

23 lines (14 loc) · 634 Bytes

Example title

What's an example use case that demonstrates the project? What can you do with this example?

Prerequisites (or assumptions)

  • What is required to get started with this example?
  • list all assumptions

Task title

  • Show an example with real use case and real data. Example that is just syntax may not help much.

Result

What do you see when you run that example?

Troubleshoot

-list potential pitfalls -how to debug if something does not go as planned

(Optional) Uninstall or clean up

If you want users to delete/uninstall or clean up what they have done, give them instructions on how to do it.