This repository has been archived by the owner on Jun 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |