Skip to content

better readme #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
omeid merged 1 commit into from
Jul 20, 2025
Merged

better readme #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ Lightweight, zero-dependency, and extendable configuration management.
uConfig is extremely light and extendable configuration management library with zero dependencies. Every aspect of configuration is provided through a _plugin_, which means you can have any combination of flags, environment variables, defaults, secret providers, Kubernetes Downward API, and any combination of configuration files and formats including json, toml, cue, or just about anything you want, and only what you want, through plugins.


uConfig takes the config schema as a struct decorated with tags, nesting is supported.

Supports all basic types, time.Duration, and any other type through `encoding.TextUnmarshaler` interface.
See the _[flat view](https://godoc.org/github.com/omeid/uconfig/flat)_ package for details.
To use uConfig, you simply define the configuration struct for your services and application, and uConfig does all the heavy-lifting. It just works.

## Example Configuration:

Expand All @@ -22,6 +19,7 @@ type Config struct {
Database string `default:"my-project"`
}
```

```go
package redis
// Config describes the requirement for redis client.
Expand All @@ -48,6 +46,7 @@ import (
"github.com/omeid/uconfig/examples/sample/redis"
)


// Config is our application config.
type Config struct {
// yes you can have slices.
Expand Down Expand Up @@ -112,8 +111,9 @@ Configuration Files:
config.json

```
```sh
$ go run main.go

```
```json
{
"Hosts": [
Expand All @@ -137,6 +137,8 @@ $ go run main.go

```

uConfig supports all basic types, time.Duration, slices, and any other type through `encoding.TextUnmarshaler` interface.
See the _[flat view](https://godoc.org/github.com/omeid/uconfig/flat)_ package for details.

## Custom names:

Expand All @@ -146,8 +148,7 @@ Sometimes you might want to use a different env var, or flag name for backwards

You can change the name of a field as seen by `uconfig`.

Please not that this flag only works for walker plugins (flags, env, anything flat) and for Visitor plugins (file, stream, et al) you will need
to use encoder specific tags like `json:"field_name"` and so on.
Please note that this flag only works for walker plugins (flags, env, anything flat) and for Visitor plugins (file, stream, et al) you will need to use encoder specific tags like `json:"field_name"` and so on.


2. Plugin specific tags
Expand All @@ -156,16 +157,16 @@ Most plugins support controlling the field name as seen by that specific plugin.


For both type of tags, you can prefix them with `.` to rename the field only at the struct level.
See the `Service.Port` and DB_NAME examples below.
See the `Service.Port` and `DB_NAME` examples below.

```go
package database

// Config holds the database configurations.
type Database struct {
Address string `default:"localhost"`
Port string `default:"28015" uconfig:".Service.Port"`
Database string `default:"my-project" env:"DB_NAME" flag:"main-db-name"`
Port string `default:"28015" uconfig:".Service.Port"` // field level rename.
Database string `default:"my-project" env:"DB_NAME" flag:"main-db-name"` // plugin specific rename.
}
```

Expand Down