Skip to content

Commit ca584ef

Browse files
committed
Updated Readme file
1 parent eb61905 commit ca584ef

File tree

1 file changed

+9
-129
lines changed

1 file changed

+9
-129
lines changed

README.md

Lines changed: 9 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -6,148 +6,28 @@ Material Design-inspired UI components for SwiftUI.
66

77
## Overview
88
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.
1010

1111
## Requirements
1212

1313
- iOS 15.0 and above
1414

15-
## Preview
16-
17-
<details>
18-
<summary> Get a glimpse of MaterialUI components: </summary>
19-
20-
---
21-
## Alert
22-
![Alert](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/f3098833-2f6e-4758-a5a3-9da37c72aa97)
23-
24-
---
25-
## Button
26-
![Button](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/8a1fa8ab-84ab-4058-bfa1-a8aa8d7da1b6)
27-
28-
---
29-
## Card View
30-
![CardView](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/366b24f4-78a1-4c67-bde6-76ce3e83c2b8)
31-
32-
---
33-
## Checkbox
34-
![Checkbox](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/2fdcfad1-7456-4e0f-94c5-00a683627539)
35-
36-
---
37-
## Date Picker
38-
![DatePicker](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/ce23247f-4fa4-4c75-9841-8c062902adbc)
39-
40-
---
41-
## Dialog Sheet
42-
![Dialog Sheet](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/4018cb9b-64c5-4b99-a6ca-b452277cc056)
43-
44-
---
45-
## Floating Button
46-
![FAB](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/fca45946-4c95-4d65-b834-054763e456ba)
47-
48-
---
49-
## Icon Button
50-
![IconButton](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/001f5052-38e6-46c0-aa06-f187b690730c)
51-
52-
---
53-
## List
54-
![List](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/00589eb0-14bf-445a-a525-20a02dbf4065)
55-
56-
---
57-
## Navigation View
58-
![NavigationView](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/f94f73cb-0a8d-4f49-b122-3c8ce46b9614)
59-
60-
---
61-
## Progress View
62-
![ProgressView](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/6ab95c67-6b4a-4618-a2d7-c421df4e4e79)
63-
64-
---
65-
## SearchBar
66-
![SearchBar](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/40b05fa6-24a5-41fe-9e2b-d89b4fb14611)
67-
68-
---
69-
## Segmented Control
70-
![SegmentedControl](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/4e048a08-c759-4b59-8d18-bbd6568e1bcd)
71-
72-
---
73-
## Snackbar
74-
![SnackBar](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/aa5bd193-4463-48f4-8d30-7415fa13630f)
75-
76-
---
77-
## Switch
78-
![Switch](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/fe3c6276-1c2b-4acd-a5df-1145dc999d45)
79-
80-
---
81-
## TabView
82-
![TabVIew](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/f38be0ad-8195-466b-a889-470813b2db5c)
83-
84-
---
85-
## TimePicker
86-
![TimePicker](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/bca2c916-e30f-40b6-969e-6703b865b37d)
87-
88-
---
89-
## Text & Secure Field
90-
![TextField](https://github.com/aumChauhan/MaterialUIKit/assets/83302656/093b5ed5-1d39-4ba4-966d-ef68fc5f0939)
91-
92-
</details>
93-
94-
## Installation
95-
96-
To integrate MaterialUIKit into your project, you can use `CocoaPods` or `Swift Package Manager`.
97-
98-
<details>
99-
<summary> <strong> CocoaPods </strong> </summary>
100-
101-
Add the following line to your Podfile:
102-
103-
```ruby
104-
pod 'MaterialUIKit'
105-
```
106-
107-
Then run `pod install` to install the framework.
108-
109-
</details>
110-
111-
<details>
112-
<summary> <strong> Swift Package Manager </strong> </summary>
113-
114-
In Xcode, go to File -> Swift Packages -> Add Package Dependency and enter the repository URL:
115-
116-
```other
117-
https://github.com/aumChauhan/MaterialUIKit.git
118-
```
119-
120-
</details>
121-
122-
## Getting Started
123-
124-
- 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
12516

126-
```swift
127-
import SwiftUI
128-
import MaterialUIKit
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.
12918

130-
@main
131-
struct YourApp: App {
132-
init() {
133-
MaterialUI.tint = MaterialUIColorThemes.blue
134-
}
19+
- Each component's documentation page includes a preview of the component's appearance.
13520

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
14222

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

145-
## Documentation
25+
- **Feature Requests:** For feature requests, open an issue or submit an implementation via a pull request.
14626

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

14929
## License
15030

151-
MaterialUIKit is released under the [MIT License](LICENSE)
31+
- MaterialUIKit is released under the [MIT License](LICENSE)
15232

15333

0 commit comments

Comments
 (0)