added iOS source code

[wl-app.git] / iOS / Pods / MenuItemKit / README.md

diff --git a/iOS/Pods/MenuItemKit/README.md b/iOS/Pods/MenuItemKit/README.md
new file mode 100644 (file)
index 0000000..4fea37d
--- /dev/null
+++ b/iOS/Pods/MenuItemKit/README.md
@@ -0,0 +1,48 @@
+# MenuItemKit
+
+`MenuItemKit` provides image and block(closure) support for `UIMenuItem`.
+
+`MenuItemKit` is a Swift project but Objective-C is supported without any doubt.
+
+
+## How to use
+
+1. Add the `MenuItemKit` repository as a submodule of your application’s repository.
+2. Drag and drop `MenuItemKit.xcodeproj` into your application’s Xcode project or workspace.
+3. On the “General” tab of your application target’s settings, add `MenuItemKit.framework` to the “Embedded Binaries” section.
+
+If you would prefer to use Carthage or CocoaPods, please pull request.
+
+`MenuItemKit` is very easy to adopt, it provides only 2 APIs:
+
+``` swift
+typealias MenuItemAction = (UIMenuItem) -> ()
+
+extension UIMenuItem {
+    convenience init(title: String, image: UIImage?, action: MenuItemAction)
+    convenience init(title: String, action: MenuItemAction)
+}
+```
+
+For Objective-C, `MenuItemKit` provides prefixed API names for safe reasons:
+
+```objc
+@interface UIMenuItem (SWIFT_EXTENSION(MenuItemKit))
+- (nonnull instancetype)mik_initWithTitle:(NSString * _Nonnull)title image:(UIImage * _Nullable)image action:(MenuItemAction _Nonnull)action;
+- (nonnull instancetype)mik_initWithTitle:(NSString * _Nonnull)title action:(MenuItemAction _Nonnull)action;
+@end
+```
+
+Just init `UIMenuItem`s with above APIs, and set them to `menuItems` of `UIMenuItemController`. `MenuItemKit` will take care of the rest parts, you don't need to add any code related to responder chain in your view or view controller.
+
+Check dome projects (both Swift and Objective-C are provided) for more details.
+
+## About Me
+
+* Twitter: [@_cxa](https://twitter.com/_cxa)
+* Apps available in App Store: <http://lazyapps.com>
+* PayPal: xianan.chen+paypal 📧 gmail.com, buy me a cup of coffee if you find it's useful for you, thanks.
+
+## License
+
+`MenuItemKit` is released under the MIT license. In short, it's royalty-free but you must keep the copyright notice in your code or software distribution.