Skip to content

Commit

Permalink
Add Architecture in my README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
vigneshs committed Oct 3, 2024
1 parent 4da1d2b commit 3ee2f5d
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
<i> </div> <p align="center"> A quantum voting system utilizing quantum superposition and entanglement for secure and private voting</i></b> </p>

## </div> <p align="center"> <b>Quantum Voting meets Blockchain!</b> </p>
### <p align="left">🚀 Project Overview</p>
## <p align="left">🚀 Project Overview</p>
Q-Vote simulates a secure voting process using quantum computing, with future plans for blockchain integration and a user-friendly web interface. This project uses Qiskit to simulate quantum voting and lays the groundwork for secure, private voting systems of the future.

<div align="center">

### Architecture
## <p align="left"> 🏗️ Architecture </p>

```mermaid
graph TD
Expand Down Expand Up @@ -37,7 +37,7 @@ Q-Vote simulates a secure voting process using quantum computing, with future pl
end
```

### </div> <p align="left">✨ Features</p>
## </div> <p align="left">✨ Features</p>
- 🧑‍🔬 Quantum Voting using Qiskit
- 🗳️ Multiple Voters Simulation
- 📊 Voting Results Visualization with histograms
Expand All @@ -49,7 +49,7 @@ More voting options and candidate choices
<div align="left">
<a href="https://qiskit.org/"><img src="https://img.shields.io/badge/Qiskit-6929c4?style=for-the-badge&logo=IBM&logoColor=white"></a> <a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white"></a> <a href="https://flask.palletsprojects.com/"><img src="https://img.shields.io/badge/-Flask-000000?logo=flask&logoColor=white&style=for-the-badge"></a> <a href="https://www.javascript.com/"><img src="https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=JavaScript&logoColor=black"></a> <a href="https://nodejs.org/en/"><img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=white"></a>

### </div> <p align="left">📋 Requirements</p>
## </div> <p align="left">📋 Requirements</p>
To run Q-Vote, ensure you have the following installed:

- 🐍 Python 3.x
Expand Down Expand Up @@ -102,15 +102,15 @@ python src/quantum_voting.py
```
The output will display vote counts, the winning candidate, and a histogram to visualize the results.

### <p align="left">🛠 Contributing</p>
## <p align="left">🛠 Contributing</p>
We welcome contributions! Here's how you can contribute:

- [ ] 🔗 Implement blockchain integration for immutability.
- [ ] 🌐 Develop a web interface for a better voting experience.
- [ ] 🔄 Optimize quantum circuits for efficiency.
- [ ] ✍️ Write unit tests for code reliability.

#### Steps to Contribute:
### Steps to Contribute:
1. Fork the repository.

2. Create an issue for new features or bug fixes:
Expand Down Expand Up @@ -153,10 +153,10 @@ git push origin feature-name



### <p align="left">📄 License</p>
## <p align="left">📄 License</p>
This project is licensed under the MIT licensed. See the [LICENSE](./LICENSE) file for details.

### <p align="left">❤️ Acknowledgments</p>
## <p align="left">❤️ Acknowledgments</p>
- 💻 Qiskit – The quantum computing SDK used in this project.
- 🙌 Contributors and community members – Thank you for your valuable feedback and suggestions.
### <div align="center"> <p>If you find this project helpful, give it a star ⭐!</p> </div>
## <div align="center"> <p>If you find this project helpful, give it a star ⭐!</p> </div>

0 comments on commit 3ee2f5d

Please sign in to comment.