diff --git a/README.md b/README.md index 9c3ae80..9fa31f6 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Convert string to camel case, snake case, kebab case / slugify, custom delimiter Suffix - + Acronym @@ -357,6 +357,16 @@ Suffix makes sure string has been suffixed with a given string and avoids adding ``` +#### Acronym() string + +Acronym func returns acronym of input string. You can chain ToUpper() which with make result all upercase or ToLower() which will make result all lower case or Get which will return result as it is + +```go + acronym := stringy.New("Laugh Out Loud") + fmt.Println(acronym.Acronym().ToLower()) // lol +``` + + ## Running the tests ``` bash diff --git a/example/main.go b/example/main.go index 7b8a192..f6b8339 100644 --- a/example/main.go +++ b/example/main.go @@ -82,6 +82,5 @@ func main() { fmt.Println(pun.Suffix("hanger")) // this really is a cliffhanger acronym := stringy.New("Laugh Out Loud") - // fmt.Println(acronym.Acronym().Get()) // LOL fmt.Println(acronym.Acronym().ToLower()) // lol }