Skip to content

Commit 59ff7cf

Browse files
committed
Add example links to readme and additional sentence to intro.
1 parent 959cb2d commit 59ff7cf

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
[![codecov](https://codecov.io/gh/trevex/copre/branch/main/graph/badge.svg?token=BMKV7KD2M8)](https://codecov.io/gh/trevex/copre)
77
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B29362%2Fgithub.com%2Ftrevex%2Fcopre.svg?type=shield)](https://app.fossa.com/projects/custom%2B29362%2Fgithub.com%2Ftrevex%2Fcopre?ref=badge_shield)
88

9-
10-
119
`copre` is a small library for loading **co**nfiguration from multiple sources with a user-defined **pre**cedence and merging them. The sources include [`pflags`](https://github.com/spf13/pflag), environment-variables and files (bring your own file-format).
1210

11+
While `copre` can be used standalone with only `pflags`. It was created to accomodate existing projects also utilizing [`cobra`](https://github.com/spf13/cobra).
12+
1313
## Overview
1414

1515
With `copre` it is straightforward to express how your configuration should be loaded.
@@ -19,8 +19,8 @@ With `copre` it is straightforward to express how your configuration should be l
1919
* One-way to populate a configuration `struct`
2020
* Struct-tags to specify options for environment variables and flags
2121
* Minimal defaults, opt-in to features using options instead (intentionally explicit)
22-
* Flexible `Loader`-composition as many passes as required (see example Y)
23-
* Easy to extend (see example X)
22+
* Flexible `Loader`-composition as many passes as required (see example [Using options](https://github.com/trevex/copre#using-options))
23+
* Easy to extend (see example [Custom `Loader`](https://github.com/trevex/copre#custom-loader))
2424

2525
## Install
2626

0 commit comments

Comments
 (0)