Skip to content

Commit

Permalink
Add Podspec and update README (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyenhuy authored Mar 4, 2018
1 parent a2f4090 commit dd26598
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
20 changes: 20 additions & 0 deletions AsyncMessagesViewController.podspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Pod::Spec.new do |spec|
spec.name = 'AsyncMessagesViewController'
spec.version = '0.1'
spec.license = { :type => 'MIT', :file => 'LICENSE' }
spec.homepage = 'https://github.com/nguyenhuy/AsyncMessagesViewController'
spec.authors = { 'Huy Nguyen' => 'http://huytnguyen.me' }
spec.summary = 'A smooth, responsive and flexible messages UI library for iOS apps.'
spec.source = { :git => 'https://github.com/nguyenhuy/AsyncMessagesViewController.git', :tag => spec.version.to_s }
spec.module_name = 'AsyncMessagesViewController'
spec.header_dir = 'AsyncMessagesViewController'
spec.documentation_url = 'https://github.com/nguyenhuy/AsyncMessagesViewController'
spec.platform = :ios
spec.ios.deployment_target = '9.0'
spec.swift_version = '4.0'
spec.requires_arc = true
spec.source_files = 'Source/**/*.swift'
spec.ios.resource_bundle = { spec => 'Source/Assets/AsyncMessagesViewController.xcassets' }
spec.dependency 'Texture', '2.6'
spec.dependency 'SlackTextViewController', '1.9.6'
end
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# AsyncMessagesViewController

A smooth, responsive and flexible messages UI library for iOS. Built on top of the awesome [AsyncDisplayKit](https://github.com/facebook/AsyncDisplayKit) framework, it takes full advantage of asynchronous sizing, (non-auto) layout and text rendering to deliver a 5x fps (subject to increase) scrolling experience.
A smooth, responsive and flexible messages UI library for iOS apps. Built on top of the awesome [Texture](http://github.com/TextureGroup/Texture/) (formerly AsyncDisplayKit) framework, it takes full advantage of asynchronous layout and rendering to deliver a "butter smooth" scrolling experience.

![Screenshot1](Screenshots/screenshot1.png)    ![Screenshot2](Screenshots/screenshot2.png)

## Dependencies
* [AsyncDisplayKit](https://github.com/facebook/AsyncDisplayKit).
* [SlackTextViewController](https://github.com/slackhq/SlackTextViewController) (to take advantages of its awesome features and customizations. Why reinvent the wheel?).
* [Texture](http://github.com/TextureGroup/Texture/).
* [SlackTextViewController](https://github.com/slackhq/SlackTextViewController)

## Requirements
* iOS 8 and later.
* iOS 9 and later.
* Swift 4.
* ARC.
* Swift.

## Installation
### From [CocoaPods](http://cocoapods.org):
Expand All @@ -20,8 +20,6 @@ A smooth, responsive and flexible messages UI library for iOS. Built on top of t
pod 'AsyncMessagesViewController'
````

Can't do it? Well I'm sorry but the pod won't be available until AsyncDisplayKit hits v2.0.

### Without CocoaPods
Copy the `Source\` directory to your project and install all dependencies.

Expand All @@ -46,7 +44,7 @@ Copy the `Source\` directory to your project and install all dependencies.

## Customizations
* Custom bubble node:
* Please read [this guide](http://asyncdisplaykit.org/docs/subclassing.html) on writting a custom `ASDisplayNode`.
* Please read [this guide](http://texturegroup.org/docs/subclassing.html) on subclassing `ASDisplayNode`.
* Implement a factory that conforms to `MessageBubbleNodeFactory` protocol.
* Inject your factory to `DefaultAsyncMessagesCollectionViewDataSource` via its initializer.
* Inject the data source to `AsyncMessagesViewController` (also via its initializer).
Expand Down

0 comments on commit dd26598

Please sign in to comment.