diff --git a/README.md b/README.md index 589e578..d38e0f1 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![License](https://img.shields.io/badge/License-Apache_License_2.0-orange)](#license) [![issues - vilmos](https://img.shields.io/github/issues/Vinetwigs/stres)](https://github.com/Vinetwigs/stres/issues) -
A simple and easy-to-use library to import and export string resources into your Go applications just like you would do in Android Studio. @@ -148,9 +148,9 @@ type Nesting struct { `String, err := stres.NewString("name", "value")` -| Parameter | Type | Description | -|-----------|--------|---------------------------------------|---|---|---|---|---|---|---| -| name | string | unique name to identify the string | | | | | | | | +| Parameter | Type | Description | +|-----------|--------|---------------------------------------| +| name | string | unique name to identify the string | | value | string | string to associate to the given name | Returns String instance and error. @@ -162,10 +162,10 @@ Returns String instance and error. `strArr, err := stres.NewStringArray("name", []string{"value1","value2",...})` -| Parameter | Type | Description | -|-----------|--------|---------------------------------------|---|---|---|---|---|---|---| -| name | string | unique name to identify the string | | | | | | | | -| values | []string | array of strings to associate to the given name | +| Parameter | Type | Description | +|-----------|--------|---------------------------------------| +| name | string | unique name to identify the string | +| values | []string | array of strings to associate to the given name | Returns StringArray instance and error. @@ -177,8 +177,8 @@ Returns StringArray instance and error. `qntStr, err := stres.NewQuantityString("name", []string{"zero","one", "two", ...})` | Parameter | Type | Description | -|-----------|--------|---------------------------------------|---|---|---|---|---|---|---| -| name | string | unique name to identify the string | | | | | | | | +|-----------|--------|---------------------------------------| +| name | string | unique name to identify the string | | values | []string | array of strings for quantities to associate to the given name | Returns Plural instance and error. @@ -191,8 +191,8 @@ Returns Plural instance and error. `stres.SetFewThreshold(25)` | Parameter | Type | Description | -|-----------|--------|---------------------------------------|---|---|---|---|---|---|---| -| value | int | new value for 'few' threshold | | | | | | | | +|-----------|--------|---------------------------------------| +| value | int | new value for 'few' threshold | Returns Plural instance and error. @@ -204,8 +204,8 @@ Returns Plural instance and error. `str := GetString("name")` | Parameter | Type | Description | -|-----------|--------|---------------------------------------|---|---|---|---|---|---|---| -| name | string | unique name given to the corresponding string | | | | | | | | +|-----------|--------|---------------------------------------| +| name | string | unique name given to the corresponding string | Returns a string. @@ -217,8 +217,8 @@ Returns a string. `strArr := GetStringArray("name")` | Parameter | Type | Description | -|-----------|--------|---------------------------------------|---|---|---|---|---|---|---| -| name | string | unique name given to the corresponding string-array | | | | | | | | +|-----------|--------|---------------------------------------| +| name | string | unique name given to the corresponding string-array | Returns an array of strings. @@ -230,10 +230,16 @@ Returns an array of strings. `strArr := GetQuantityString("name", 10)` | Parameter | Type | Description | -|-----------|--------|---------------------------------------|---|---|---|---|---|---|---| -| name | string | unique name to identify the string | | | | | | | | +|-----------|--------|---------------------------------------| +| name | string | unique name to identify the string | | count | int | quantity to fetch the corresponding string | Returns a string. -[Back to top](#table-of-contents) \ No newline at end of file +[Back to top](#table-of-contents) + +## Contributors + + + + diff --git a/go.mod b/go.mod index 629bc63..47193d8 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ module github.com/Vinetwigs/stres -go 1.17 \ No newline at end of file +go 1.17