Skip to content

Commit 2f49b55

Browse files
committed
Docs: Update README for version 2.0
1 parent 6721936 commit 2f49b55

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,29 @@
1-
![MUILogo70x70](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/cd2d537e-436b-4ca2-b5e6-0893894192e2)
1+
![MaterialUIKit@70px](https://github.com/user-attachments/assets/c6e6b9be-e61d-423d-82c4-1156dd14d068)
22

33
# MaterialUIKit
44

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.
86

97
## 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.
1210

1311
## Requirements
1412

15-
- iOS 15.0 and above
13+
Compatible with iOS 15.0 and later.
1614

1715
## Documentation
1816

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/).
2018

21-
- Each component's documentation page includes a preview of the component's appearance.
19+
## Demonstration
2220

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).
2422

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
2824

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.
3026

3127
## License
3228

33-
- MaterialUIKit is released under the [MIT License](LICENSE)
29+
MaterialUIKit is released under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)