diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 643cc6f..9109f1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,11 @@ We love your input! We want to make contributing to iOS Widget Development Kit as easy and transparent as possible. -## We Develop with Github +## We Develop with GitHub We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. -## We Use Github Flow +## We Use GitHub Flow Pull requests are the best way to propose changes to the codebase: @@ -42,7 +42,7 @@ We use conventional commits for our commit messages. In short, when you submit code changes, your submissions are understood to be under the same [MIT License](https://choosealicense.com/licenses/mit/) that covers the project. -## Report bugs using Github's issue tracker +## Report bugs using GitHub's issue tracker We use GitHub issues to track public bugs. Report a bug by opening a new issue. diff --git a/Documentation/README.md b/Documentation/README.md index 39f8d8d..397f628 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -1,28 +1,28 @@ # Documentation Index -- [](&)Documentation/API-Reference.md -- [](&)Documentation/API.md -- [](&)Documentation/APIReference.md -- [](&)Documentation/ArchitectureGuide.md -- [](&)Documentation/Best-Practices.md -- [](&)Documentation/ConfigurationAPI.md -- [](&)Documentation/CustomizationAPI.md -- [](&)Documentation/CustomizationGuide.md -- [](&)Documentation/DataIntegrationAPI.md -- [](&)Documentation/DataIntegrationGuide.md -- [](&)Documentation/DynamicIslandAPI.md -- [](&)Documentation/DynamicIslandGuide.md -- [](&)Documentation/Getting-Started.md -- [](&)Documentation/GettingStarted.md -- [](&)Documentation/HomeScreenWidgetAPI.md -- [](&)Documentation/HomeScreenWidgetGuide.md -- [](&)Documentation/Installation.md -- [](&)Documentation/InstallationGuide.md -- [](&)Documentation/LiveActivityAPI.md -- [](&)Documentation/LiveActivityGuide.md -- [](&)Documentation/LockScreenWidgetAPI.md -- [](&)Documentation/LockScreenWidgetGuide.md -- [](&)Documentation/PerformanceGuide.md -- [](&)Documentation/Troubleshooting.md -- [](&)Documentation/UsageGuide.md -- [](&)Documentation/WidgetDevelopmentManagerAPI.md +- [API-Reference.md +- [API.md +- [APIReference.md +- [ArchitectureGuide.md +- [Best-Practices.md +- [ConfigurationAPI.md +- [CustomizationAPI.md +- [CustomizationGuide.md +- [DataIntegrationAPI.md +- [DataIntegrationGuide.md +- [DynamicIslandAPI.md +- [DynamicIslandGuide.md +- [Getting-Started.md +- [GettingStarted.md +- [HomeScreenWidgetAPI.md +- [HomeScreenWidgetGuide.md +- [Installation.md +- [InstallationGuide.md +- [LiveActivityAPI.md +- [LiveActivityGuide.md +- [LockScreenWidgetAPI.md +- [LockScreenWidgetGuide.md +- [PerformanceGuide.md +- [Troubleshooting.md +- [UsageGuide.md +- [WidgetDevelopmentManagerAPI.md diff --git a/README.md b/README.md index 1426eaf..fd1b9dc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # 📱 iOS Widget Development Kit -[![CI](https://github.com/muhittincamdali/iOS-Widget-Development-Kit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/muhittincamdali/iOS-Widget-Development-Kit/actions/workflows/ci.yml) +[![CI](https://github.com/muhittincamdali/iOS-Widget-Development-Kit/actions/workflows/ci.yml/badge.svg)](https://github.com/muhittincamdali/iOS-Widget-Development-Kit/actions/workflows/ci.yml) @@ -17,7 +17,6 @@ ![Data](https://img.shields.io/badge/Data-Integration-795548?style=for-the-badge) ![Architecture](https://img.shields.io/badge/Architecture-Clean-FF5722?style=for-the-badge) ![Swift Package Manager](https://img.shields.io/badge/SPM-Dependencies-FF6B35?style=for-the-badge) -![CocoaPods](https://img.shields.io/badge/CocoaPods-Supported-E91E63?style=for-the-badge) **🏆 Professional iOS Widget Development Kit**