You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-129Lines changed: 9 additions & 129 deletions
Original file line number
Diff line number
Diff line change
@@ -6,148 +6,28 @@ Material Design-inspired UI components for SwiftUI.
6
6
7
7
## Overview
8
8
9
-
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.
9
+
-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.
10
10
11
11
## Requirements
12
12
13
13
- iOS 15.0 and above
14
14
15
-
## Preview
16
-
17
-
<details>
18
-
<summary> Get a glimpse of MaterialUI components: </summary>
- To quickly enhance your SwiftUI app with MaterialUI components, **Set Color Palette Tint:** Customize the color palette used throughout MaterialUI components by setting the `tint` property. Add this code to your app's entry point.
15
+
## Documentation
125
16
126
-
```swift
127
-
importSwiftUI
128
-
importMaterialUIKit
17
+
- 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.
129
18
130
-
@main
131
-
structYourApp: App {
132
-
init() {
133
-
MaterialUI.tint= MaterialUIColorThemes.blue
134
-
}
19
+
- Each component's documentation page includes a preview of the component's appearance.
135
20
136
-
var body: some Scene {
137
-
// Your app's main scene configuration
138
-
}
139
-
}
140
-
```
141
-
`MaterialUIColorThemes` include Blue, Green, Pink, and Purple color palettes.
21
+
## Communication and Contribution
142
22
143
-
> NOTE: If you don't explicitly set a theme in the `init` block, MaterialUI will use the Pink theme by default.
23
+
-**Reporting Bugs:** If you find a bug, please open an issue or submit a fix via a pull request.
144
24
145
-
## Documentation
25
+
-**Feature Requests:** For feature requests, open an issue or submit an implementation via a pull request.
146
26
147
-
Detailed documentation for each component can be found [here](https://github.com/aumChauhan/MaterialUIKit/blob/main/DOCUMENTATION.md). Make sure to check it out for comprehensive usage examples and customization options.
27
+
-**Contributing:** Contributions are always welcome! Feel free to submit a pull request onto the master branch.
148
28
149
29
## License
150
30
151
-
MaterialUIKit is released under the [MIT License](LICENSE)
31
+
-MaterialUIKit is released under the [MIT License](LICENSE)
0 commit comments