diff --git a/README.md b/README.md index 11a0c40..fdf43b8 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ ## `Carch Official Documentation` +

+ +This is the official documentation for [Carch](https://github/harilvfs/carch) +

+

@@ -22,26 +27,26 @@

-## 📚 Build Documentation +### 📚 Build Documentation
-### 🛠️ Clone Repository +#### 🛠️ Clone Repository ```sh git clone https://github.com/carch-org/docs cd docs ``` -### 🏗️ Build +#### 🏗️ Build *To generate the static documentation files:* ```sh npm run docs:build ``` -### 👀 Preview +#### 👀 Preview *To preview the generated build locally:* ```sh @@ -50,7 +55,7 @@ npm run docs:preview *Copy the local IP address provided and paste it into your browser to view the documentation.* -### 🔄 Development Build +#### 🔄 Development Build *To see live changes while editing the documentation:*