Skip to content

Commit

Permalink
📝 Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
UltiRequiem committed Oct 7, 2021
1 parent e623515 commit 7c9a934
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 6 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ go get github.com/UltiRequiem/lorelai/pkg

## Examples

### Generating Text

```go
func printTonsOfText() {
for i := 0; i < 10; i++ {
fmt.Println(lorelai.Paragraph())
}
}
```

### Convenience Utilities

```go
Expand Down Expand Up @@ -97,9 +107,9 @@ If you don't pass any flag or you pass the help flag:
--url A random URL
--email A random Email Address
--email A random Email Address
--color Print the output with colors?
--color Print the output with colors?
Examples:
lorelai -w 55 # Will print 55 words
Expand Down
4 changes: 2 additions & 2 deletions cmd/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ func printHelp() {
--url A random URL
--email A random Email Address
--email A random Email Address
--color Print the output with colors?
--color Print the output with colors?
Examples:
lorelai -w 55 # Will print 55 words
Expand Down
14 changes: 12 additions & 2 deletions example/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"github.com/UltiRequiem/lorelai/pkg"
)

func main() {
func sayHi() {
fmt.Println(fmt.Sprintf("My, my name is: %s.", lorelai.Word()))
fmt.Println(fmt.Sprintf("My email address is %s", lorelai.Email()))
fmt.Println(fmt.Sprintf("My website is: %s", lorelai.URL()))
Expand All @@ -19,5 +19,15 @@ func main() {

fmt.Println(fmt.Sprintf("Didn't you like the story? Let me tell you 4 words abou the author:"))

fmt.Println(lorelai.LoremWords(4))
fmt.Println(lorelai.LoremWords(4))
}

func printTonsOfText() {
for i := 0; i < 10; i++ {
fmt.Println(lorelai.Paragraph())
}
}

func main() {
printTonsOfText()
}

0 comments on commit 7c9a934

Please sign in to comment.