Skip to content

Commit 8918fe0

Browse files
Mark Pospeselmpospese
authored andcommitted
Add hero banner and SPI badges to README
Update Installation steps
1 parent aef1758 commit 8918fe0

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,47 @@
1-
# YCoreUI
2-
Core components for iOS to accelerate building user interfaces in code.
3-
4-
This framework comprises UIView extensions for declarative AutoLayout, UIColor extensions for WCAG 2.0 contrast ratio calculations, and UIScrollView extensions to assist with keyboard avoidance.
1+
![Y-CoreUI](https://mpospese.com/wp-content/uploads/2022/08/YCoreUI-hero-compact.jpeg)
2+
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fyml-org%2FYCoreUI%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/yml-org/YCoreUI) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fyml-org%2FYCoreUI%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/yml-org/YCoreUI)
3+
_Core components for iOS to accelerate building user interfaces in code._
4+
5+
This lightweight framework primarily comprises:
6+
7+
* UIView extensions for declarative Auto Layout
8+
* UIScrollView extensions to assist with keyboard avoidance
9+
* UIColor extensions for WCAG 2.0 contrast ratio calculations
10+
11+
It also contains miscellaneous other Foundation and UIKit extensions.
512

613
Documentation
714
----------
815

916
Documentation is automatically generated from source code comments and rendered as a static website hosted via GitHub Pages at: https://yml-org.github.io/YCoreUI/
1017

11-
Requirements
18+
Installation
19+
----------
20+
21+
You can add Y-CoreUI to an Xcode project by adding it as a package dependency.
22+
23+
1. From the **File** menu, select **Add Packages...**
24+
2. Enter "[https://github.com/yml-org/YCoreUI](https://github.com/yml-org/YCoreUI)" into the package repository URL text field
25+
3. Click **Add Package**
26+
27+
Contributing to Y-CoreUI
1228
----------
1329

14-
### SwiftLint (linter)
30+
### Requirements
31+
32+
#### SwiftLint (linter)
1533
```
1634
brew install swiftlint
1735
```
1836

19-
### Jazzy (documentation)
37+
#### Jazzy (documentation)
2038
```
2139
sudo gem install jazzy
2240
```
2341

24-
Setup
25-
----------
26-
27-
Open `Package.swift` in Xcode.
42+
### Setup
2843

29-
Contributing to Y-Core-UI
30-
----------
44+
Clone the repo and open `Package.swift` in Xcode.
3145

3246
### Versioning strategy
3347

0 commit comments

Comments
 (0)