From ba58c7d9d1aa1f170a4ba212c0f760664183668c Mon Sep 17 00:00:00 2001 From: Batkhuu Date: Fri, 8 Sep 2023 16:58:48 +0900 Subject: [PATCH] :memo: Updated README.md file. --- README.md | 3 ++- docs/scripts/4.test.md | 6 ++++++ docs/scripts/6.build.md | 6 ++++++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f0ab240..d714b84 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,9 @@ - **Main config** based on **Pydantic schema** - - Load **environment variables** - +- Load from **multiple** configs directories - Load configs from **YAML** and **JSON** files -- Update the default config with additional configurations (**`extra_configs`** directory) +- Update the default config with additional configurations (**`extra_dir`** directory) - **Pre-load hook** function to modify config data before loading and validation - **Validate config** values with **Pydantic validators** - Config as **dictionary** or **Pydantic model** (with type hints) diff --git a/docs/scripts/4.test.md b/docs/scripts/4.test.md index d8fb929..c2a3f4b 100644 --- a/docs/scripts/4.test.md +++ b/docs/scripts/4.test.md @@ -16,3 +16,9 @@ To execute the test script, simply run the following command in the terminal: ``` **Source code**: [**`test.sh`**](../../scripts/test.sh) + +--- + +### References + +- \ No newline at end of file diff --git a/docs/scripts/6.build.md b/docs/scripts/6.build.md index bc4a871..21aa75e 100644 --- a/docs/scripts/6.build.md +++ b/docs/scripts/6.build.md @@ -30,3 +30,9 @@ To execute the build script with the different flags, use the following commands This script is particularly beneficial for developers, streamlining the build, testing, and publishing process. It provides a one-stop solution for all the build needs of a Python project, reducing chances of errors and ensuring consistency. **Source code**: [**`build.sh`**](../../scripts/build.sh) + +--- + +### References + +- \ No newline at end of file