Skip to content

docs: improve README, fix links and capitalization.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hiteshydv001 merged 6 commits into from
Aug 17, 2025
Merged

docs: improve README, fix links and capitalization.md #1

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4896abd
docs: improve README, fix links and capitalization.md
Sejal-hani Aug 15, 2025
b769a97
Fixed clone command in README.md
Sejal-hani Aug 15, 2025
97df7f3
Update README.md
Hiteshydv001 Aug 15, 2025
99fdda8
Updated all required Hitesh in links to OpenVoiceX in README.md
Sejal-hani Aug 16, 2025
1821a41
Update README.md
Sejal-hani Aug 16, 2025
5f8331e
Update README.md
Sejal-hani Aug 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
</p>

<p align="center">
<a href="https://github.com/your-username/dialogweaver/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
<a href="https://github.com/Hiteshydv001/DialogWeaver/issues"><img src="https://img.shields.io/github/issues/your-username/dialogweaver" alt="GitHub issues"></a>
<a href="https://github.com/Hiteshydv001/DialogWeaver/blob/main/docs/Contribution.md"><img src="https://img.shields.io/badge/PRs-Welcome-brightgreen.svg" alt="PRs Welcome"></a>
<a href="#"><img src="https://img.shields.io/static/v1?label=Discord&message=Join%20Chat&color=7289DA&logo=discord" alt="Join the community on Discord"></a>
<a href="https://github.com/OpenVoiceX/DialogWeaver/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
<a href="https://github.com/OpenVoiceX/DialogWeaver/issues"><img src="https://img.shields.io/github/issues/OpenVoiceX/DialogWeaver" alt="GitHub issues"></a>
<a href="https://github.com/OpenVoiceX/DialogWeaver/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-Welcome-brightgreen.svg" alt="PRs Welcome"></a>

</p>

---
Expand Down Expand Up @@ -42,7 +42,7 @@ DialogWeaver is built as a modern, service-oriented monorepo. This design provid
| **`database`**| Persistent relational data storage. | `PostgreSQL` |
| **`cache`** | In-memory data store for caching and session management. | `Redis` |

![DialogWeaver Architecture Diagram](https://github.com/Hiteshydv001/DialogWeaver/blob/main/docs/Architecture.png)
![DialogWeaver Architecture Diagram](https://github.com/OpenVoiceX/DialogWeaver/blob/main/docs/Architecture.png)


---
Expand All @@ -57,8 +57,8 @@ Get the entire DialogWeaver platform running on your local machine in just a few

### 1. Clone the Repository
```bash
git clone https://github.com/your-username/dialogweaver.git
cd dialogweaver
git clone https://github.com/OpenVoiceX/DialogWeaver.git
cd DialogWeaver
```

### 2. Configure Your Environment
Expand Down Expand Up @@ -101,3 +101,9 @@ Please read our **[CONTRIBUTING.md](CONTRIBUTING.md)** to get started with the d
## License

This project is licensed under the MIT License - see the **[LICENSE](LICENSE)** file for details.