Skip to content

Commit fc8b1c6

Browse files
committed
Merge readme
2 parents f2849d4 + fc3d9e3 commit fc8b1c6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Use the [ShortLook](https://dynastic.co/shortlook) API to create plugins that pr
1313
3. Rename your main class (DD_RENAMETHIS_ContactPhotoProvider).
1414
4. Using the [Info.plist reference](#infoplist), change any values you may need to in `Info.plist`.
1515
5. Implement your logic inside your main class's `contactPhotoPromiseOfferForNotification:` method ([details](#provider-classes)).
16+
6. Configure your `Makefile` and `control` as you would a normal tweak, [using these tips](#metadata-tips).
1617

1718
## Provider Structure and Explanation
1819

@@ -62,6 +63,11 @@ The promise object also features many properties, such as `usesCaching` and `bac
6263

6364
If your image is returned instantly, rather than by using a network request, you can use a convenience method on `DDNotificationContactPhotoPromiseOffer`, named `offerInstantlyResolvingPromiseWithPhotoIdentifier:image:`. Just return the generated promise from your provider. Choose wisely, though. This method should only be used if you can get your image absolutely instantly. If you take too long using this synchronous method, ShortLook may penalize your provider.
6465

66+
## Metadata Tips
67+
68+
- Your package should usually be called something like "APP Photo Provider for ShortLook" in Cydia.
69+
- It is recommended you make your bundle name something like "ShortLook-APP".
70+
6571
## Full Documentation
6672

6773
You can view the full class documentation for ShortLook's photo provider API [here](https://dynastic.github.io/ShortLook-API/).
@@ -71,4 +77,4 @@ You can view the full class documentation for ShortLook's photo provider API [he
7177
You can look at the following open source provider examples to get an idea of how to use the ShortLook API:
7278

7379
- [Blank Template](https://www.github.com/dynastic/ShortLook-API-Template/)
74-
- [Twitter](https://www.github.com/dynastic/ShortLook-Twitter/)
80+
- [Twitter](https://www.github.com/dynastic/ShortLook-Twitter/)

0 commit comments

Comments
 (0)