Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ The library is supported on Apple platforms and Linux.

## Configuration providers

### Built-in providers

The library includes comprehensive built-in provider support:

- Environment variables: [`EnvironmentVariablesProvider`](https://swiftpackageindex.com/apple/swift-configuration/documentation/configuration/environmentvariablesprovider)
Expand All @@ -125,6 +127,10 @@ The library includes comprehensive built-in provider support:
- In-memory: [`InMemoryProvider`](https://swiftpackageindex.com/apple/swift-configuration/documentation/configuration/inmemoryprovider) and [`MutableInMemoryProvider`](https://swiftpackageindex.com/apple/swift-configuration/documentation/configuration/mutableinmemoryprovider)
- Key transforming: [`KeyMappingProvider`](https://swiftpackageindex.com/apple/swift-configuration/documentation/configuration/keymappingprovider)

### Community providers

- TOML file: [mattt/swift-configuration-toml](https://github.com/mattt/swift-configuration-toml)

You can also implement a custom [`ConfigProvider`](https://swiftpackageindex.com/apple/swift-configuration/documentation/configuration/configprovider) for specialized configuration formats and sources.

## Key features
Expand Down
6 changes: 6 additions & 0 deletions Sources/Configuration/Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,8 @@ To understand the choices available, see <doc:Choosing-reader-methods>.

#### Providers

##### Built-in providers

The library includes comprehensive built-in provider support:

- Environment variables: ``EnvironmentVariablesProvider``
Expand All @@ -241,6 +243,10 @@ The library includes comprehensive built-in provider support:
- In-memory: ``InMemoryProvider`` and ``MutableInMemoryProvider``
- Key transforming: ``KeyMappingProvider``

##### Community providers

- TOML file: [mattt/swift-configuration-toml](https://github.com/mattt/swift-configuration-toml)

You can also implement a custom ``ConfigProvider``.

#### Provider hierarchy
Expand Down