diff --git a/README.md b/README.md index 5d0d6dc..b6fdf6f 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,342 @@ +
+ +``` + __ __ _ _ __ _ _ + \ \ / /(_) _ __ | |/ /(_)| |_ + \ \ /\ / / | || '_ \ | ' / | || __| + \ V V / | || | | || . \ | || |_ + \_/\_/ |_||_| |_||_|\_\|_| \__| +``` +
+ WinKit +

+ Version 1.0 + Windows 11 + GitHub license + Maintenance Active +

+ πŸ› οΈ Supercharge your Windows 11 experience with WinKit - the all-in-one solution for managing, optimizing, and customizing your system! πŸš€ +
+ --- -# WinKit +## πŸ“š Table of Contents + +
-## Overview +| πŸš€ [Key Features](#-key-features) | πŸ› οΈ [Installation](#️-installation) | πŸ–₯️ [Usage](#️-usage) | +|:---------------------------------:|:----------------------------------:|:---------------------:| +| πŸ› οΈ [Contributing](#️-contributing) | πŸ—ΊοΈ [Roadmap](#️-roadmap) | πŸ“„ [License](#-license) | +| πŸ“Š [Repository Stats](#-repository-stats) | ⚠️ [Disclaimer](#️-disclaimer) | ⭐ [Show Support](#-show-your-support) | -WinKit is a comprehensive toolkit designed to streamline system maintenance and optimization tasks on Windows systems. It offers a collection of utilities and scripts aimed at enhancing performance, resolving common issues, and optimizing system settings. +
-## Features +--- -- **AppXPackages Updater (Winget)**: Automatically updates AppX packages using WinGet. -- **AppXPackages Reseter**: Resets AppX packages to default settings. -- **Timer Resolution Server Install**: Installs and configures server-side timer resolution for optimized performance. -- **MSI Mode**: Enables MSI installations for compatibility and deployment ease. -- **DirectX Check / Installers**: Ensures DirectX compatibility and installs necessary components. -- **Visual C++ Redistributable Check / Installers**: Installs required Visual C++ Redistributable packages. -- **Registry Optimizations**: Optimizes Windows registry settings for improved performance. -- **Repair Windows**: Fixes system issues and restores stability. -- **Repair Windows Store**: Restores Windows Store functionality. -- **Clear Windows Explorer Cache**: Enhances file browsing speed by clearing Explorer cache. +## πŸ“Š Repository Stats -## Usage +
-1. Clone the repository: - ``` - git clone https://github.com/luckyjr5/WinKit.git +### 🌟 Activity +![GitHub stars](https://img.shields.io/github/stars/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=yellow) +![GitHub forks](https://img.shields.io/github/forks/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=blue) +![Last Commit](https://img.shields.io/github/last-commit/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=orange) +![Commit Activity](https://img.shields.io/github/commit-activity/m/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=blue) + +# + +### πŸ› Issues +![GitHub issues](https://img.shields.io/github/issues/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=red) +![GitHub closed issues](https://img.shields.io/github/issues-closed/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=green) + +# + +### πŸ“¦ Size and Contributors +![Repo Size](https://img.shields.io/github/repo-size/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=purple) +![Code Size](https://img.shields.io/github/languages/code-size/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=purple) +![Contributors](https://img.shields.io/github/contributors/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=blue) + +# + +### 🌐 Community +![Discussions](https://img.shields.io/github/discussions/DuckyOnQuack-999/WinKit?style=for-the-badge&logo=github&color=yellow) +![Total Downloads](https://img.shields.io/github/downloads/DuckyOnQuack-999/WinKit/total?style=for-the-badge&logo=github&color=brightgreen) + +
+ +--- + +## πŸš€ Key Features + +
+ App Management + System Optimization + Privacy Controls + Software Installation +
+ +
+πŸ–₯️ App Management + +# +- **Get-InstalledStoreApps**: Retrieve and display installed Windows Store apps +- **Repair-StoreApp**: Fix issues with selected Windows Store apps +- **Uninstall-App**: Remove apps locally or globally +- **Update-StoreApps**: Automatically update all installed Store apps +- **Export-AppList**: Generate a list of installed apps for easy reinstallation + +# +
+ + +
+πŸ” Local Group Policy + +# +- **Reset-LocalGroupPolicy**: Restore default local group policy settings +- **Clear-Logs & Refresh-Logs**: Manage log displays effectively +- **Export-GroupPolicy**: Save current group policy settings for backup +- **Import-GroupPolicy**: Restore group policy settings from a backup + +# +
+ + +
+πŸ“¦ Installers + +# +- **Install-VisualCppRedistributable**: Get the latest Visual C++ Redistributables +- **Install-DirectX**: Update or install DirectX +- **Install-DotNetSDKs**: Set up multiple .NET SDK versions +- **Install-WindowsSubsystemForLinux**: Set up WSL with your preferred Linux distribution +- **Install-PackageManager**: Install and configure popular package managers (Chocolatey, Scoop, Winget) + +# +
+ + +
+πŸ”§ Tweaks + +# +- **Disable-Telemetry**: Enhance privacy by turning off data collection +- **Enable-DarkMode**: Activate system-wide dark theme +- **Disable-Cortana**: Turn off Windows virtual assistant +- **Optimize-WindowsSearch**: Improve search functionality and reduce resource usage +- **Customize-StartMenu**: Personalize your Start menu layout and functionality + +# +
+ + +
+πŸš€ Optimization + +# +- **Clean-TemporaryFiles**: Free up disk space +- **Defragment-Drives**: Improve system performance +- **Optimize-Startup**: Speed up boot times +- **Manage-WindowsServices**: Fine-tune system services for better performance +- **Analyze-SystemPerformance**: Get detailed reports on system bottlenecks and suggestions for improvement + +# +
+ + +
+πŸ”’ Privacy + + # +- **Disable-ActivityHistory**: Stop Windows from tracking your activity +- **Manage-AppPermissions**: Control data access for apps +- **Clear-BrowsingData**: Clean up your browsing history and cache +- **Configure-WindowsFirewall**: Set up advanced firewall rules for better security +- **Encrypt-PersonalData**: Set up BitLocker encryption for your drives + +# +
+ + +--- + +## πŸ› οΈ Installation + +
+ Windows Terminal + PowerShell +
+ + + Ensure PowerShell 5.1+ is installed on your Windows 11 system + + Open PowerShell as Administrator + + + Clone the repository: + ```powershell + git clone https://github.com/DuckyOnQuack-999/WinKit.git ``` -2. Run the desired script or utility using PowerShell: + + Navigate to WinKit directory: + ```powershell + cd WinKit ``` - .\WinKit_v1.ps1 + + + Run the main script: + ```powershell + .\WinKit.ps1 ``` -## Contributions +--- + +## πŸ–₯️ Usage + +Launch WinKit and use its intuitive interface to: +- Manage and repair Windows Store apps +- Reset and manage local group policies +- Install essential software components +- Apply system tweaks and optimizations +- Enhance your privacy settings + +Always review changes before applying and consider creating a system restore point for safety. + +
+πŸ“Š Performance Metrics + +Track your system's performance improvements with WinKit: + +- **Boot Time**: Measure and compare boot times before and after optimization +- **Disk Space**: Monitor freed up disk space after cleaning temporary files +- **Memory Usage**: Track RAM usage improvements +- **CPU Utilization**: Analyze CPU performance enhancements +- **Battery Life**: For laptops, measure battery life improvements + +
+ +
+πŸ”„ Automatic Updates + +WinKit now includes an auto-update feature: +- Check for updates: `.\WinKit.ps1 -CheckForUpdates` +- Apply updates: `.\WinKit.ps1 -Update` +- Configure update frequency in the settings menu + +
+ +--- + +## πŸ› οΈ Contributing + +

+ Contributions Welcome + Issues Welcome +

+ +We welcome contributions! Here's how: + +- Fork the repository +- Create your feature branch (`git checkout -b feature/AmazingFeature`) +- Commit your changes (`git commit -m 'Add some AmazingFeature'`) +- Push to the branch (`git push origin feature/AmazingFeature`) +- Open a Pull Request + +Please ensure your code adheres to our standards and includes appropriate documentation. + +
+πŸ§ͺ Testing + +Before submitting a pull request: + +- Run all unit tests: `.\Tests\Run-UnitTests.ps1` +- Perform integration tests: `.\Tests\Run-IntegrationTests.ps1` +- Update documentation if you've added new features or changed existing functionality + +
+ +--- + +## πŸ—ΊοΈ Roadmap -Contributions and feedback are welcome! Feel free to submit issues, feature requests, or pull requests. +

+ Roadmap +

+- [x] Initial Release with core features +- [ ] Enhanced App Management (ETA: Q4 2024) + - Batch app repair and uninstallation + - Detailed app health diagnostics +- [ ] Advanced System Tweaks (ETA: Q1 2025) + - Custom power plans + - Registry optimization tools +- [ ] Multi-language Support (ETA: Q2 2025) + - Interface localization + - Region-specific optimizations +- [ ] Performance Analytics (ETA: Q3 2025) + - Real-time system performance monitoring + - Automated optimization recommendations + +
+πŸ“ˆ Feature Voting + +Help us prioritize future features: + +1. Visit our [GitHub Discussions](https://github.com/DuckyOnQuack-999/WinKit/discussions) page +2. Look for the "Feature Requests" category +3. Vote on existing features or suggest new ones + +Top-voted features will be prioritized in our development roadmap! + +
+ +--- + +## ⚠️ Disclaimer + +While we strive for safety and effectiveness, use WinKit at your own risk. Always back up your system before making significant changes. The authors and contributors are not responsible for any damage or data loss. + +--- + +## πŸ“„ License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. --- +## ⭐ Show Your Support + +

+ + Star this repo + + + Fork this repo + +

+ +If you find WinKit helpful, please consider giving it a star ⭐ It helps the project grow and improve! + +
+πŸ™ Acknowledgements + +We'd like to thank the following projects and communities: + +- [PowerShell](https://github.com/PowerShell/PowerShell) +- [Windows Terminal](https://github.com/microsoft/terminal) +- [Chocolatey](https://chocolatey.org/) +- [Scoop](https://scoop.sh/) +- [Windows Package Manager (winget)](https://github.com/microsoft/winget-cli) + +Your contributions to the open-source community have been invaluable in the development of WinKit. + +
+ +--- + +

+ Made with ❀️ by DuckyOnQuack-999 +

+ +---