Skip to content

Commit 5cd62b5

Browse files
committed
Added docs.
1 parent dd341fb commit 5cd62b5

7 files changed

+19
-0
lines changed

Docs/Images/Icon-TwoLineTitle.png

42.5 KB
Loading

Docs/Images/Icon.png

25.8 KB
Loading
434 KB
Loading
441 KB
Loading

Docs/Images/OnlyURL.png

12.4 KB
Loading

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# SMLinkPreview
22

3+
## Features
4+
5+
### The goal of this library is:
6+
1. To (a) separate the fetching or acquisition of link preview data from (b) the view or UI aspects of the link preview.
7+
2. To enable the app using the link preview data fetching to not have to disable Application Transport Security (ATS).
8+
3. To flexibly allow for different web-based API services that fetch link preview data.
9+
10+
### The LinkPreview view adapts to different available data:
11+
12+
![LargeImage OneLineTitle](Docs/Images/LargeImage-OneLineTitle.png "LargeImage OneLineTitle")
13+
![LargeImage TwoLineTitle](LargeImage-TwoLineTitle.png "LargeImage TwoLineTitle")
14+
![Only URL](OnlyURL.png "Only URL")
15+
![Icon and URL](Icon.png "Icon and URL")
16+
![Icon TwoLineTitle](Icon-TwoLineTitle.png "Icon TwoLineTitle")
17+
318
## Example
419

520
To run the example project, clone the repo, and run `pod install` from the Example directory first.

VERSIONS.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
SMLinkPreview
2+
3+
Version 0.1.0
4+
* Initial release.

0 commit comments

Comments
 (0)