Skip to content

Commit 42466cd

Browse files
author
Tom Softreck
committed
docs: Update project metadata, add CHANGELOG.md, and enhance README
1 parent a29f262 commit 42466cd

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,80 @@
1919

2020
</div>
2121

22+
TaskProvision is an AI-Powered Development Automation Platform that helps developers automate repetitive tasks, generate high-quality code, and maintain code quality standards.
23+
24+
## 🚀 Features
25+
26+
- AI-powered code generation
27+
- Automated code quality checks
28+
- Task management and automation
29+
- Integration with popular development tools
30+
- Extensible architecture
31+
32+
## 📦 Installation
33+
34+
### Using pip
35+
```bash
36+
pip install taskprovision
37+
```
38+
39+
### From source
40+
```bash
41+
git clone https://github.com/taskprovision/python.git
42+
cd python
43+
pip install -e .[dev]
44+
```
45+
46+
## 🛠️ Development Setup
47+
48+
1. Clone the repository:
49+
```bash
50+
git clone https://github.com/taskprovision/python.git
51+
cd python
52+
```
53+
54+
2. Set up a virtual environment:
55+
```bash
56+
python -m venv venv
57+
source venv/bin/activate # On Windows: venv\Scripts\activate
58+
```
59+
60+
3. Install development dependencies:
61+
```bash
62+
pip install -e .[dev]
63+
```
64+
65+
4. Install pre-commit hooks:
66+
```bash
67+
pre-commit install
68+
```
69+
70+
## 🧪 Running Tests
71+
72+
```bash
73+
# Run all tests
74+
pytest
75+
76+
# Run tests with coverage
77+
pytest --cov=taskprovision --cov-report=term-missing
78+
```
79+
80+
## 📚 Documentation
81+
82+
Documentation is available at [taskprovision.readthedocs.io](https://taskprovision.readthedocs.io/).
83+
84+
## 🤝 Contributing
85+
86+
Contributions are welcome! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
87+
88+
## 📄 License
89+
90+
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
91+
92+
## 📞 Support
93+
94+
For support, please open an [issue](https://github.com/taskprovision/python/issues) or email info@softreck.dev.
95+
2296
TaskProvision - AI-Powered Development Automation Platform
2397

2498
# 🚀 WronAI AutoDev - AI-Powered Development Automation Platform

0 commit comments

Comments
 (0)