Skip to content

Commit 31d55e8

Browse files
committed
Update readme
1 parent cb6a313 commit 31d55e8

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
<p align="center">
2-
<img src ="Resources/Logo_Rounded.png" alt="ScrollKit Logo" title="ScrollKit" />
2+
<img src="Resources/Icon.png" alt="Project Icon" width="250" />
33
</p>
44

55
<p align="center">
66
<img src="https://img.shields.io/github/v/release/danielsaidi/ScrollKit?color=%2300550&sort=semver" alt="Version" title="Version" />
77
<img src="https://img.shields.io/badge/swift-6.0-orange.svg" alt="Swift 6.0" />
88
<img src="https://img.shields.io/badge/platform-SwiftUI-blue.svg" alt="Swift UI" title="SwiftUI" />
9+
<a href="https://danielsaidi.github.io/ScrollKit"><img src="https://img.shields.io/badge/documentation-web-blue.svg" alt="Documentation" /></a>
910
<img src="https://img.shields.io/github/license/danielsaidi/ScrollKit" alt="MIT License" title="MIT License" />
10-
<a href="https://twitter.com/danielsaidi"><img src="https://img.shields.io/twitter/url?label=Twitter&style=social&url=https%3A%2F%2Ftwitter.com%2Fdanielsaidi" alt="Twitter: @danielsaidi" title="Twitter: @danielsaidi" /></a>
11-
<a href="https://mastodon.social/@danielsaidi"><img src="https://img.shields.io/mastodon/follow/000253346?label=mastodon&style=social" alt="Mastodon: @danielsaidi@mastodon.social" title="Mastodon: @danielsaidi@mastodon.social" /></a>
1211
</p>
1312

1413

1514

16-
## About ScrollKit
15+
# ScrollKit
1716

1817
ScrollKit is a SwiftUI SDK that adds powerful scroll features, like offset tracking and a header view that stretches & transforms as you pull down, and sticks to the top when you scroll.
1918

@@ -37,7 +36,7 @@ https://github.com/danielsaidi/ScrollKit.git
3736

3837
## Getting started
3938

40-
ScrollKit has a `ScrollViewWithOffsetTracking` view that can detect scrolling:
39+
ScrollKit has a `ScrollViewWithOffsetTracking` that can detect scrolling on all OS versions:
4140

4241
```swift
4342
ScrollViewWithOffsetTracking { offset in
@@ -47,7 +46,7 @@ ScrollViewWithOffsetTracking { offset in
4746
}
4847
```
4948

50-
ScrollKit also has a `ScrollViewWithStickyHeader` that makes it easy to set up a stretchy, sticky header:
49+
ScrollKit has a `ScrollViewWithStickyHeader` that makes it easy to set up a stretchy, sticky header:
5150

5251
```swift
5352
struct MyView: View {
@@ -112,9 +111,9 @@ Your support makes it possible for me to put more work into these projects and m
112111
Feel free to reach out if you have questions or want to contribute in any way:
113112

114113
* Website: [danielsaidi.com][Website]
115-
* Mastodon: [@danielsaidi@mastodon.social][Mastodon]
116-
* Twitter: [@danielsaidi][Twitter]
117114
* E-mail: [daniel.saidi@gmail.com][Email]
115+
* Bluesky: [@danielsaidi@bsky.social][Bluesky]
116+
* Mastodon: [@danielsaidi@mastodon.social][Mastodon]
118117

119118

120119

@@ -125,15 +124,15 @@ ScrollKit is available under the MIT license. See the [LICENSE][License] file fo
125124

126125

127126
[Email]: mailto:daniel.saidi@gmail.com
128-
129127
[Website]: https://danielsaidi.com
130128
[GitHub]: https://github.com/danielsaidi
131-
[Twitter]: https://twitter.com/danielsaidi
132-
[Mastodon]: https://mastodon.social/@danielsaidi
133129
[OpenSource]: https://danielsaidi.com/opensource
134130
[Sponsors]: https://github.com/sponsors/danielsaidi
135131

132+
[Bluesky]: https://bsky.app/profile/danielsaidi.bsky.social
133+
[Mastodon]: https://mastodon.social/@danielsaidi
134+
[Twitter]: https://twitter.com/danielsaidi
135+
136136
[Documentation]: https://danielsaidi.github.io/ScrollKit/
137137
[Getting-Started]: https://danielsaidi.github.io/ScrollKit/documentation/scrollkit/getting-started
138-
139138
[License]: https://github.com/danielsaidi/ScrollKit/blob/master/LICENSE

0 commit comments

Comments
 (0)