examples/format.md

Data format

This project uses markdown as its data storage format. The syntax used is important and wasn't chosen randomly.

Syntax for examples

<!-- ExampleName must not contain spaces or special characters and has to begin with a capital letter -->
- `ExampleName`: A comment
```markdown <!-- a language can be added to enable syntax highlighting -->
Data here
```

Headers also matter from the method name is generated from the text in them, ie:

# IRC
## PING
- `ExampleUsage`: Example usage of `PING`
```
PING :test
```

The path for the Ping example is IrcPing, so the whole function name for Go will be IrcPingExampleUsage.