Skip to content

Commit

Permalink
Add example links to readme and additional sentence to intro.
Browse files Browse the repository at this point in the history
  • Loading branch information
trevex committed Jan 4, 2022
1 parent 959cb2d commit 59ff7cf
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
[![codecov](https://codecov.io/gh/trevex/copre/branch/main/graph/badge.svg?token=BMKV7KD2M8)](https://codecov.io/gh/trevex/copre)
[![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)



`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).

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

## Overview

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

## Install

Expand Down

0 comments on commit 59ff7cf

Please sign in to comment.