doc: updated README with description

* fixes #3 Signed-off-by: Frédéric BIDON <[email protected]>
go-openapi · Feb 2, 2024 · f507f21 · f507f21
1 parent 273c980
commit f507f21
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,3 +8,11 @@
 A package to pluralize words.
 
 Originally forked from fork of https://bitbucket.org/pkg/inflect under a MIT License.
+
+A golang library applying grammar rules to English words.
+
+> This package provides a basic set of functions applying
+> grammar rules to inflect English words, modify case style
+> (Capitalize, camelCase, snake_case, etc.).
+>
+> Acronyms are properly handled. A common use case is word pluralization.