Adding usage examples

Signed-off-by: Matthew Stobbs <matthew@stobbs.ca>
This commit is contained in:
Matthew Stobbs 2024-02-23 22:05:10 -07:00
parent 198d509789
commit 172dfa9109

View File

@ -1,3 +1,21 @@
TinD is highly configurable, and defaults to an extremely simple set of values: TinD is highly configurable, and defaults to an extremely simple set of values:
- Default size of 4 bytes, or 32bits - Default size of 4 bytes, or 32bits
- Default character set of upper and lower case alphabet characters `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` - Default character set of upper and lower case alphabet characters `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ`
# Usage Examples
```go
package main
import (
"git.staur.ca/stobbsm/tind"
)
func main() {
id := tind.Gen()
fmt.Println(id.String())
}
```
Output:
```sh
CvHG
```