Skip to content

Commit

Permalink
docs: remove unnecessary migration and add note at top
Browse files Browse the repository at this point in the history
  • Loading branch information
mhweiner committed Dec 19, 2024
1 parent a86c3d8 commit ac7ea18
Showing 1 changed file with 1 addition and 25 deletions.
26 changes: 1 addition & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# brek
# brek (formerly lambdaconf)

[![build status](https://github.com/mhweiner/lambdaconf/actions/workflows/release.yml/badge.svg)](https://github.com/mhweiner/lambdaconf/actions)
[![SemVer](https://img.shields.io/badge/SemVer-2.0.0-blue)]()
Expand Down Expand Up @@ -100,30 +100,6 @@ To run this manually, you can run `npx brek`. This will generate the `Conf.d.ts`

You can also use [loaders](#loaders) or [environment variables](#environment-variables-in-config-files).

#### Migration from `lambdaconf`

To migrate, simply replace `lambdaconf` with `brek` in your `package.json`:
```bash
npm uninstall lambdaconf
npm install brek

# Usage

## Example Configuration File

_conf/default.json_
```json
{
"foo": "bar",
"fruits": ["apples", "oranges"],
"thingEnabled": false,
"maxFruits": 123,
"wow": {
"foo": "bar"
}
}
```

## Configuration Rules

- `default.json` is required, everything else is optional. Recommended practice is that `default.json` contains all of your "local development" settings.
Expand Down

0 comments on commit ac7ea18

Please sign in to comment.