mirror of
https://github.com/MessageKit/MessageKit.git
synced 2026-02-06 19:03:19 +00:00
Dan Leonard
81 lines
3.0 KiB
Markdown
81 lines
3.0 KiB
Markdown
# MessageKit
|
|
|
|
[](https://travis-ci.org/MessageKit/MessageKit) [](https://codecov.io/gh/MessageKit/MessageKit)
|
|
|
|
|
|
<!---->Insert Banner
|
|
|
|
Welcome to MessagesKit.
|
|
|
|
## Table of Contents
|
|
[**Goal**](#Goal)
|
|
* [**Goal**](#Goal)📈
|
|
* [**Contributing**](#Contributing)
|
|
* [**Getting started**](#Getting-started)
|
|
* [**Requirements**](#Requirements)
|
|
* [**Code of Conduct**](#Code-of-Conduct)
|
|
* [**What's Next**](#What's-Next)
|
|
* [**Apps using this library**](#Apps-using-this-library)
|
|
* [**License**](#License)
|
|
[**Installation Options**](#font-installation)
|
|
|
|
## Goal
|
|
|
|
- Provide a safe 👩🚒 enviroment for others to learn an grow through Open Source.
|
|
- Make adding `Chat` to a project easy.💬
|
|
- Enable beautiful Chat UI's.
|
|
- Provide an awesome Open Source project for people by people.
|
|
- Help others learn.
|
|
|
|
#### Vision
|
|
See [VISION.md](https://github.com/MessageKit/MessageKit/blob/master/VISION.md) for Goals, Scope, & Technical Considerations.
|
|
|
|
### `Getting started`
|
|
**Recomended**
|
|
## [CocoaPods](https://cocoapods.org/)
|
|
Use `CocoaPods` add
|
|
````ruby
|
|
pod 'MessageKit'
|
|
````
|
|
to your `Podfile` and run `pod update`
|
|
|
|
|
|
## `Requirements`
|
|
|
|
* iOS10 or later
|
|
|
|
## `Contributing`
|
|
|
|
- This is great that you want to contribute 💯. Your what makes this possible, We would appriciate if you would look over these [Contributing Guide Lines](https://cocoapods.org/) to help us keep this community awesome.
|
|
- Then come join us on [Slack](https://join.slack.com/t/messagekit/shared_invite/MjI0NDkxNjgwMzA3LTE1MDIzMTU0MjUtMzJhZDZlNTkxMA) and 🗣 don't be a stranger.
|
|
- The Projcet is in active development and the branches my not be in sync so speak up in `SLACK` and communicate with what you are or want to work on.
|
|
- Check out the current [issues](https://github.com/MessageKit/MessageKit/issues) and see if you can tackle any of those.
|
|
- Check out the current code base and suggest any improvements you would like to work on by creating a `New Issue`.
|
|
- Check out the [**What's Next**](#What's-Next) section 👇 to see where we are headed.
|
|
- Install [SwiftLint] too keep yourself in 👨🎤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.
|
|
|
|
#Apps using this library#
|
|
|
|
Add your app to the list of apps using this library and make a pull request. We appriciate you and hope you contribute. *Please provide attribution, it is greatly appreciated.*
|
|
## License
|
|
## `License`
|
|
|
|
`MessageKit` is released under an [MIT License][mitLink].🤓
|
|
* Many thanks to [**the contributors**](https://github.com/MessageKit/MessageKit/graphs/contributors) of this project.
|
|
|
|
[mitLink]:http://opensource.org/licenses/MIT
|
|
*Please provide attribution, it is greatly appreciated.*
|
|
|
|
Inspired by [JSQMessagesViewController](https://github.com/jessesquires/JSQMessagesViewController) 👈 💯
|
|
|
|
## Font Installation
|
|
|
|
### `Option 1: Download and Install Manually`
|
|
|
|
|