Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
futuretap committed Nov 28, 2023
1 parent 95906d0 commit f95026e
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
FTiCloudSync
============
Automatically syncs NSUserDefaults across multiple iOS devices using iCloud.
# FTiCloudSync
[![License](https://img.shields.io/badge/Platform-iOS-gray)](https://creativecommons.org/licenses/by-sa/4.0/)
[![License](https://img.shields.io/badge/License-CC--BY--SA_4.0-gray)](https://creativecommons.org/licenses/by-sa/4.0/)
[![Sponsor](https://img.shields.io/badge/Sponsor-ff40a0)](https://github.com/sponsors/futuretap)
[![Mastodon](https://img.shields.io/mastodon/follow/000010558?domain=https%3A%2F%2Fmastodon.cloud)](https://mastodon.cloud/@ortwingentz)

Automatically syncs NSUserDefaults across multiple iOS devices using iCloud key-value storage (`NSUbiquitousKeyValueStore`).

Installation
------------
## Installation
Drag all files into your Xcode project.


Requirements
------------
iCloud requires iOS 5.0 or later. However, this code builds and runs fine under iOS 4.0 or later. If iCloud is not available, this code does nothing.
## Requirements
iCloud requires iOS 5.0 or later. If iCloud is not available, this code does nothing.


Usage
-----
## Usage
All write and remove requests to NSUserDefaults are automatically synchronized with iCloud. To prevent synchronization for individual keys, prefix the key with a ! (exclamation mark).

To respond to updates from iCloud you can observe the `FTiCloudSyncDidUpdateNotification`. It contains the `NSUserDefaults` object and in the `userInfo` a dictionary with `FTiCloudSyncChangedKeys` and `FTiCloudSyncRemovedKeys`. These are arrays of the changed and removed keys.

<a href="https://flattr.com/thing/799300/futuretapiTunesFeaturedCheck-on-GitHub" target="_blank">
<img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a>

Compatibility
-------------
## Compatibility
FTiCloudSync is compatible with [InAppSettingsKit](http://www.inappsettingskit.com), a framework to easily add in-app settings to iPhone apps. InAppSettingsKit automatically updates the UI when an iCloud update is received.


License
-------
## Author
Developed by [Ortwin Gentz](https://www.futuretap.com/about/ortwin-gentz) ([Mastodon](https://mastodon.cloud/@ortwingentz)) and used in [FutureTap](https://www.futuretap.com)’s [Where To?](https://wheretoapp.com) and [Streets](https://streets.app) apps – we eat our own dog food!


## License
Licensed under [CC-BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/).

You are free to share, adapt and make commercial use of the work as long as you give attribution and keep this license. To give credit, we suggest this text in the about screen or App Store description: "Uses FTiCloudSync by Ortwin Gentz", with a link to the [GitHub page](https://github.com/futuretap/FTiCloudSync).
Expand All @@ -38,4 +38,7 @@ If you need a different license without attribution requirement, please contact
Includes:

- [RegexKitLite](http://regexkit.sourceforge.net/) by John Engelhart. Copyright &copy; 2008-2010 John Engelhart. Licensed under the terms of the BSD License.
- [MethodSwizzling](http://cocoadev.com/index.pl?MethodSwizzling) by Mike Ash
- [MethodSwizzling](http://cocoadev.com/index.pl?MethodSwizzling) by Mike Ash

## Sponsors wanted
If you would like to support my Open Source work, consider joining me as a [sponsor](https://github.com/sponsors/futuretap)! 💪️ Your sponsorship enables me to spend more time on this and other community projects. Thank you!

0 comments on commit f95026e

Please sign in to comment.