From 5ffedaa364eb370caa9a2cc4b7de920fc2311a0e Mon Sep 17 00:00:00 2001 From: Young Yu Date: Tue, 16 Jan 2024 11:57:43 -0800 Subject: [PATCH] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aea1674..c17d0ee 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ A simple configuration manager for Node.js applications. I created this libary s * [Usage](#usage) * [Command Line Arguments](#command-line-arguments) * [Special Environment Variables](#special-environment-variables) -* [API Reference](#api-reference) +* [Config API](#config-API) +* [EnvParser API](#Envparser-API) * [FAQ](#faq) * [Changelog](./CHANGELOG.md) * [Contributing](./CONTRIBUTING.md) @@ -213,9 +214,7 @@ The `ENV_PATH` environment variable can be set to specify a custom path to the ` If the path specified by `environment variable` is invalid, the module will attempt to search the `.env` directory to find the `.env` file matching the environment. -# API Reference - -## Config +## Config API ### configure(configOptions?: ConfigOptions): void Sets up the module, which involves the following steps : @@ -308,7 +307,7 @@ const mapString: string = Config.get('var1.var2.mapString'); const set: Set = Config.get('escaped\\\.field.inside'); ``` -## EnvParser +## EnvParser API ### refreshCache(): void Clears the environment variable cache and updates the cache with the most up-to-date environment variables.