Skip to content

Commit 2ad9210

Browse files
committed
Rebrand and update documentation for sharpify-gui
Renamed project references from Pinterest Media Scraper to sharpify-gui across documentation and code. Added release template, new banner image, and example images. Updated README, USAGE, and CONTRIBUTING guides to reflect new upscaling functionality, supported file types, and PyQt6-based UI. Fixed version numbers in main application files and removed obsolete package init file.
1 parent 805f5d1 commit 2ad9210

File tree

8 files changed

+386
-564
lines changed

8 files changed

+386
-564
lines changed

.github/RELEASE_TEMPLATE.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Release Template
2+
3+
## Version [X.Y.Z] - Release Name (YYYY-MM-DD)
4+
5+
### 🚀 What's New
6+
7+
Brief description of the major features, improvements, or changes in this release.
8+
9+
---
10+
11+
### ✨ Features
12+
13+
- **Feature Name**: Description of the new feature and its benefits
14+
- **Another Feature**: What this feature does for users
15+
- **Enhancement**: Improvement to existing functionality
16+
17+
### 🐛 Bug Fixes
18+
19+
- Fixed issue where [describe the problem and solution]
20+
- Resolved bug causing [specific issue description]
21+
- Corrected [problem] that affected [functionality]
22+
23+
### 🔧 Improvements
24+
25+
- Improved performance of [specific component/feature]
26+
- Enhanced [functionality] for better user experience
27+
- Optimized [process/algorithm] resulting in [benefit]
28+
29+
### 📚 Documentation
30+
31+
- Updated README with new installation instructions
32+
- Added examples for [specific feature]
33+
- Improved API documentation for [endpoints/methods]
34+
35+
### 🔒 Security
36+
37+
- Fixed security vulnerability in [component]
38+
- Updated dependencies to address [security issue]
39+
- Enhanced [security feature] implementation
40+
41+
### ⚠️ Breaking Changes
42+
43+
**Important**: This release contains breaking changes that may affect your implementation.
44+
45+
- **Change 1**: Description of what changed and migration steps
46+
- **Change 2**: What users need to update in their code
47+
- **Deprecated**: [Feature/API] is now deprecated and will be removed in v[X.Y.Z]
48+
49+
### 📦 Dependencies
50+
51+
- Updated [dependency] from v[X.Y.Z] to v[A.B.C]
52+
- Added new dependency: [package-name] v[X.Y.Z]
53+
- Removed deprecated dependency: [package-name]
54+
55+
### 📊 Contributors
56+
- **Contributors**: Thanks to [@username1], [@username2], [@username3]
57+
58+
### 🙏 Acknowledgments
59+
60+
Special thanks to:
61+
- [@contributor1] for implementing [feature]
62+
- [@contributor2] for reporting and helping fix [bug]
63+
- Community members who provided feedback and testing
64+
65+
### 📋 Checksums
66+
67+
**Download Verification**:
68+
```
69+
SHA256: [checksum-here]
70+
MD5: [checksum-here]
71+
```
72+
## 📞 Support
73+
74+
- 📧 Email: ujjwalkrai@gmail.com
75+
- 🐛 Issues: [Repo Issues](https://github.com/uikraft-hub/sharpify-gui/issues)
76+
- 🔓 Security: [Repo Security](https://github.com/uikraft-hub/sharpify-gui/security)
77+
- ⛏ Pull Request: [Repo Pull Request](https://github.com/uikraft-hub/sharpify-gui/pulls)
78+
- 📖 Docs: [Repo Documentation](https://github.com/uikraft-hub/sharpify-gui/tree/main/docs)
79+
- 📃 Changelog: [Repo Changelog](https://github.com/uikraft-hub/sharpify-gui/docs/CHANGELOG.md)
80+
---
81+
82+
*This release source code was tested on: Windows, MacOS and Ubuntu*

assets/sharpify-gui-banner.jpg

1.76 MB
Loading

0 commit comments

Comments
 (0)