Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and rename Examples.md to examples.md #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Examples.md

This file was deleted.

23 changes: 23 additions & 0 deletions examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 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.