Skip to content
This repository has been archived by the owner on Jun 12, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjvs authored Jun 12, 2024
1 parent ce941a0 commit 516d414
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,2 @@
# neat-config

Load complex configuration from many sources on runtime with type-safety.

Visit documentation here: [https://mrjvs.github.io/neat-config/](https://mrjvs.github.io/neat-config/)

# Features

- Strictly typed OR loosly typed configurations.
- Complex object configuration.
- Load (partial) configuration from many inputs:
- From files: `.json`, `.env`.
- From environment variables.
- From directory structure (used for i.e docker secrets).
- From CLI arguments.
- Validate from a Zod or joi schema.

# Install

```sh
npm install neat-config
```

# Documentation
Visit documentation here: [https://mrjvs.github.io/neat-config/](https://mrjvs.github.io/neat-config/)
> [!WARNING]
> Moved to `@neato/config` from [NeatoJS](https://github.com/mrjvs/neatojs).

0 comments on commit 516d414

Please sign in to comment.