Add converter module and update documentation

1 files changed, 21 insertions, 0 deletions

diff --git a/README.md b/README.md
index 40697ab..50d38ef 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,24 @@
     <img src="https://img.shields.io/badge/Status-Development%20in%20Progress-yellow?style=for-the-badge">
     <img src="https://img.shields.io/badge/Release-Not%20Available-lightgrey?style=for-the-badge">
 </p>
+
+> [!WARNING]
+> The command line and the core repository are currently under refactoring.
+> Please go to the `main` branch to get the stable version.
+>
+> Note: The new command line `jvn` and `jv` / `jvv` are **completely incompatible**.
+> They run on **entirely different** core implementations.
+
+# Intro
+`JVCS CLI` provides the command-line tool `jvn`, which binds all the functionalities of the core library:
+- Local workspace management
+- Upstream vault management
+- Raw data editing
+
+# Deploy
+> [!WARNING]
+> Currently in the refactoring phase, please refer to the `Deployment` section in the [Contribution Guide](./CONTRIBUTING.md).
+
+# License
+Consistent with the [core library](https://github.com/JustEnoughVCS/CommandLine),
+this repository adopts the dual license of [MIT](./LICENSE-MIT) and [APACHE](./LICENSE-APACHE).