|
1 |
| - |
| 1 | + |
2 | 2 |
|
3 | 3 | # MaterialUIKit
|
4 | 4 |
|
5 |
| -Material Design-inspired UI components for SwiftUI. |
6 |
| - |
7 |
| -**Sample Project:** https://github.com/aumChauhan/MaterialUIKit_SampleProject |
| 5 | +SwiftUI components inspired by Material Design. |
8 | 6 |
|
9 | 7 | ## Overview
|
10 |
| - |
11 |
| -- MaterialUIKit is a SwiftUI package offering a set of user interface components inspired by Google's Material Design. These components are designed to provide a consistent and visually appealing look to your SwiftUI applications. |
| 8 | + |
| 9 | +MaterialUIKit is a SwiftUI package offering a range of UI components inspired by Material Design. It includes components for dialogs and alerts, form controls, interactive elements, navigation structures, presentation and search. The package supports flexible configuration options to tailor the appearance and behavior of these components, facilitating the creation of material-inspired interfaces in SwiftUI applications. |
12 | 10 |
|
13 | 11 | ## Requirements
|
14 | 12 |
|
15 |
| -- iOS 15.0 and above |
| 13 | +Compatible with iOS 15.0 and later. |
16 | 14 |
|
17 | 15 | ## Documentation
|
18 | 16 |
|
19 |
| -- For detailed documentation on each component, including usage examples and customization options, please refer to the [MaterialUIKit Wiki](https://github.com/aumChauhan/MaterialUIKit/wiki). Installation and getting started instructions are also available on the wiki. |
| 17 | +For comprehensive information on each component, including usage examples and customization options, visit the MaterialUIKit [documentation](https://swift-packages.gitbook.io/materialuikit/). |
20 | 18 |
|
21 |
| -- Each component's documentation page includes a preview of the component's appearance. |
| 19 | +## Demonstration |
22 | 20 |
|
23 |
| -## Communication and Contribution |
| 21 | +For a practical demonstration and example usage of MaterialUIKit components, check out the [Sample Project](https://github.com/aumChauhan/MaterialUIKit_SampleProject). |
24 | 22 |
|
25 |
| -- **Reporting Bugs:** If you find a bug, please open an issue or submit a fix via a pull request. |
26 |
| - |
27 |
| -- **Feature Requests:** For feature requests, open an issue or submit an implementation via a pull request. |
| 23 | +## Communication and Contribution |
28 | 24 |
|
29 |
| -- **Contributing:** Contributions are always welcome! Feel free to submit a pull request onto the master branch. |
| 25 | +For bug reports, feature requests, or contributions, please open an issue or submit a pull request. All contributions are welcome and appreciated. |
30 | 26 |
|
31 | 27 | ## License
|
32 | 28 |
|
33 |
| -- MaterialUIKit is released under the [MIT License](LICENSE) |
| 29 | +MaterialUIKit is released under the [MIT License](LICENSE). |
0 commit comments