From 968430e1c302c08f75de7deec725da1ada841a88 Mon Sep 17 00:00:00 2001
From: Young Joon Lee <entelecheia@hotmail.com>
Date: Sun, 11 Jun 2023 15:51:10 +0900
Subject: [PATCH] feat(docs): add usage documentation

---
 docs/usage/envs.md  | 48 +++++++++++++++++++++++++++++++++++++++++++++
 docs/usage/index.md |  1 +
 2 files changed, 49 insertions(+)
 create mode 100644 docs/usage/envs.md
 create mode 100644 docs/usage/index.md

diff --git a/docs/usage/envs.md b/docs/usage/envs.md
new file mode 100644
index 00000000..bfd7bb1f
--- /dev/null
+++ b/docs/usage/envs.md
@@ -0,0 +1,48 @@
+# Environment variables
+
+## Utils
+
+Here's an example of how you can use the expand_posix_vars function in a Python script:
+
+```python
+from hypi.utils.env import expand_posix_vars
+
+# Define a POSIX expression with variables
+posix_expr = "The current working directory is $PWD and the user is $USER."
+
+# Call the expand_posix_vars function with the POSIX expression
+expanded_expr = expand_posix_vars(posix_expr)
+
+# Print the expanded expression
+print(expanded_expr)
+```
+
+In this example, we import the `expand_posix_vars` function from the env module. We then define a POSIX expression with two variables, `$PWD` and `$USER`. We call the `expand_posix_vars` function with the POSIX expression as an argument, which expands the variables using the current working directory and the current user. Finally, we print the expanded expression, which should output something like:
+
+```bash
+The current working directory is /home/user and the user is user.
+```
+
+You can also pass in a dictionary of additional variables to be used in the expansion, like this:
+
+```python
+from env import expand_posix_vars
+
+# Define a POSIX expression with variables
+posix_expr = "The value of MY_VAR is $MY_VAR."
+
+# Define a dictionary of additional variables
+context = {"MY_VAR": "hello world"}
+
+# Call the expand_posix_vars function with the POSIX expression and context
+expanded_expr = expand_posix_vars(posix_expr, context)
+
+# Print the expanded expression
+print(expanded_expr)
+```
+
+In this example, we define a POSIX expression with a single variable, `$MY_VAR`. We also define a dictionary of additional variables with a key of `MY_VAR` and a value of hello world. We call the `expand_posix_vars` function with the POSIX expression and context as arguments, which expands the `$MY_VAR` variable to hello world. Finally, we print the expanded expression, which should output:
+
+```bash
+The value of MY_VAR is hello world.
+```
diff --git a/docs/usage/index.md b/docs/usage/index.md
new file mode 100644
index 00000000..8f04b05a
--- /dev/null
+++ b/docs/usage/index.md
@@ -0,0 +1 @@
+# Usage