diff --git a/readme.md b/readme.md index 3e948ad..551ad95 100644 --- a/readme.md +++ b/readme.md @@ -2,8 +2,9 @@ > Swifty and modern [UserDefaults](https://developer.apple.com/documentation/foundation/userdefaults) -This package is used in production by apps like [Gifski](https://github.com/sindresorhus/Gifski), [Dato](https://sindresorhus.com/dato), [Lungo](https://sindresorhus.com/lungo), [Battery Indicator](https://sindresorhus.com/battery-indicator), and [HEIC Converter](https://sindresorhus.com/heic-converter). +It uses `NSUserDefaults` underneath but exposes a type-safe facade with lots of nice conveniences. +It's used in production by apps like [Gifski](https://github.com/sindresorhus/Gifski), [Dato](https://sindresorhus.com/dato), [Lungo](https://sindresorhus.com/lungo), [Battery Indicator](https://sindresorhus.com/battery-indicator), and [HEIC Converter](https://sindresorhus.com/heic-converter). ## Highlights @@ -14,7 +15,6 @@ This package is used in production by apps like [Gifski](https://github.com/sind - **Observation:** Observe changes to keys. - **Lightweight:** It's only some hundred lines of code. - ## Compatibility - macOS 10.12+ @@ -22,7 +22,6 @@ This package is used in production by apps like [Gifski](https://github.com/sind - tvOS 10+ - watchOS 3+ - ## Install #### SwiftPM @@ -43,7 +42,6 @@ github "sindresorhus/Defaults" pod 'Defaults' ``` - ## Usage You declare the defaults keys upfront with type and default value. @@ -248,7 +246,6 @@ print(UserDefaults.standard.bool(forKey: isUnicornMode.name)) //=> true ``` - ## API ### `Defaults` @@ -412,14 +409,12 @@ Break the lifetime tie created by `tieToLifetime(of:)`, if one exists. The effects of any call to `tieToLifetime(of:)` are reversed. Note however that if the tied-to object has already died, then the observation is already invalid and this method has no logical effect. - ## FAQ ### How is this different from [`SwiftyUserDefaults`](https://github.com/radex/SwiftyUserDefaults)? It's inspired by that package and other solutions. The main difference is that this module doesn't hardcode the default values and comes with Codable support. - ## Related - [Preferences](https://github.com/sindresorhus/Preferences) - Add a preferences window to your macOS app in minutes