mirror of
https://github.com/MessageKit/MessageKit.git
synced 2026-02-06 19:03:19 +00:00
Mark
127 lines
4.6 KiB
Markdown
127 lines
4.6 KiB
Markdown
<p>
|
|
<img src="https://raw.githubusercontent.com/MessageKit/MessageKit/master/Assets/mklogo.png" title="MessageKit logo">
|
|
</p>
|
|
|
|
[](https://dashboard.buddybuild.com/apps/59c302b7bc1f7f00013f20a2/build/latest)
|
|
[](https://codecov.io/gh/MessageKit/MessageKit)
|
|
[](https://github.com/Carthage/Carthage)
|
|
<a href="https://swift.org">
|
|
<img src="https://img.shields.io/badge/Swift-4-orange.svg"
|
|
alt="Swift" />
|
|
</a>
|
|
<a href="https://cocoapods.org/">
|
|
<img src="https://cocoapod-badges.herokuapp.com/v/MessageKit/badge.png"
|
|
alt="CocoaPods">
|
|
</a>
|
|
<a href="https://developer.apple.com/xcode">
|
|
<img src="https://img.shields.io/badge/Xcode-9-blue.svg"
|
|
alt="Xcode">
|
|
</a>
|
|
<a href="https://opensource.org/licenses/MIT">
|
|
<img src="https://img.shields.io/badge/License-MIT-red.svg"
|
|
alt="MIT">
|
|
</a>
|
|
<a href="https://github.com/MessageKit/MessageKit/issues">
|
|
<img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
|
|
alt="Contributions Welcome">
|
|
</a>
|
|
|
|
## Table of Contents
|
|
|
|
* [**Goal**](#goals)📈
|
|
* [**Contributing**](#contributing)
|
|
* [**Requirements**](#requirements)
|
|
* [**Code of Conduct**](https://github.com/MessageKit/MessageKit/blob/master/Code_of_Conduct.md)
|
|
* [**What's Next**](#whats-next)
|
|
* [**Join the Slack Group**](#join-the-slack-group)
|
|
* [**Apps using this library**](#apps-using-this-library)
|
|
* [**License**](#license)
|
|
|
|
|
|
## Goals
|
|
|
|
- Provide a :rotating_light:safe:rotating_light: environment for others to learn and grow through Open Source.
|
|
- Make adding Chat:speech_balloon: to a project easy.
|
|
- Enable beautiful and customizable Chat UI's.
|
|
- Provide an awesome Open Source project for the iOS open source community.
|
|
- Help others learn.
|
|
|
|
## Vision
|
|
See [VISION.md](https://github.com/MessageKit/MessageKit/blob/master/VISION.md) for Goals, Scope, & Technical Considerations.
|
|
|
|
|
|
## Installation
|
|
### [CocoaPods](https://cocoapods.org/) **Recommended**
|
|
````ruby
|
|
pod 'MessageKit'
|
|
````
|
|
|
|
If your project is still using Swift 3. Add the following code in your Podfile.
|
|
|
|
````
|
|
target 'TARGET_NAME' do
|
|
pod 'MessageKit'
|
|
...
|
|
post_install do |installer|
|
|
installer.pods_project.targets.each do |target|
|
|
if target.name == 'MessageKit'
|
|
target.build_configurations.each do |config|
|
|
config.build_settings['SWIFT_VERSION'] = '4.0'
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
````
|
|
|
|
### [Carthage](https://github.com/Carthage/Carthage)
|
|
|
|
To integrate MessageKit using Carthage, add the following to your `Cartfile`:
|
|
|
|
````ruby
|
|
github "MessageKit/MessageKit"
|
|
````
|
|
|
|
## Requirements
|
|
|
|
- **iOS9** or later
|
|
|
|
|
|
## Contributing
|
|
|
|
Great! Look over these things first.
|
|
- Please read our [Code of Conduct](https://github.com/MessageKit/MessageKit/blob/master/Code_of_Conduct.md)
|
|
- Check the [Contributing Guide Lines](https://github.com/MessageKit/MessageKit/blob/master/CONTRIBUTING.md).
|
|
- Come join us on [Slack](https://join.slack.com/t/messagekit/shared_invite/MjI4NzIzNzMyMzU0LTE1MDMwODIzMDUtYzllYzIyNTU4MA) and 🗣 don't be a stranger.
|
|
- Check out the [current issues](https://github.com/MessageKit/MessageKit/issues) and see if you can tackle any of those.
|
|
- Download the project and check out the current code base. Suggest any improvements by opening a new issue.
|
|
- Check out the [What's Next](#whats-next) section :point_down: to see where we are headed.
|
|
- Check [StackOverflow](https://stackoverflow.com/questions/tagged/messagekit)
|
|
- Install [SwiftLint](https://github.com/realm/SwiftLint) too keep yourself in :neckbeard: style.
|
|
- Be kind and helpful.
|
|
|
|
|
|
## What's Next?
|
|
|
|
Check out the [Releases](https://github.com/MessageKit/MessageKit/releases) to see what we are working on next.
|
|
|
|
## Join the Slack Group
|
|
|
|
Click here to join [Slack](https://join.slack.com/t/messagekit/shared_invite/MjI4NzIzNzMyMzU0LTE1MDMwODIzMDUtYzllYzIyNTU4MA)
|
|
|
|
### Apps using this library
|
|
|
|
Add your app to the list of apps using this library and make a pull request.
|
|
|
|
*Please provide attribution, it is greatly appreciated.*
|
|
|
|
## Thanks
|
|
|
|
Many thanks to [**the contributors**](https://github.com/MessageKit/MessageKit/graphs/contributors) of this project.
|
|
|
|
## License
|
|
MessageKit is released under the [MIT License](https://github.com/MessageKit/MessageKit/blob/master/LICENSE.md).
|
|
|
|
## Inspiration
|
|
Inspired by [JSQMessagesViewController](https://github.com/jessesquires/JSQMessagesViewController) :point_left: :100:
|