From 569d9051780271428038def95d0f5896263958e8 Mon Sep 17 00:00:00 2001 From: Leonel Quinteros Date: Thu, 23 Jun 2016 12:38:32 -0300 Subject: [PATCH] Improve readme --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec9a6e5..aa490f6 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,39 @@ # Gotext -GNU gettext utilities for Go +GNU gettext utilities for Go. + +- Implements GNU gettext support in native Go. +- It works with UTF-8 encoding as it's the default for Go language. +- Supports pluralization rules. +- Ready to use inside Go templates. +- Language codes are automatically simplified from the form "en_UK" to "en" if the formed isn't available. +- Unit tests available -# Examples +# Installation + +``` +go get github.com/leonelquinteros/gotext +``` + +- There are no requirements or dependencies to use this package. +- No need to install GNU gettext utilities (unless specific needs of CLI tools). +- No need for environment variables. Some naming conventions are applied but not needed. + + +# License + +[MIT license](LICENSE) + + +# Documentation + +Refer to the Godoc package documentation at (https://godoc.org/github.com/leonelquinteros/gotext) + + + +# Usage examples ## Using package for single language/domain settings