Skip to content

Commit 7628f1d

Browse files
committed
Merge pull request #2 from dasmer/daz/readme
[README.md] Initial Content
2 parents daa596e + 59b1c4e commit 7628f1d

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
11
# EmojiKit
2-
An effortless emoji-query framework
2+
EmojiKit is a simple emoji-querying framework in Swift. It is used in [Paste](https://github.com/dasmer/Paste), an Emoji Search app in the [App Store](https://itunes.apple.com/us/app/paste-emoji-search/id1070640289).
3+
4+
Installation
5+
------------
6+
If you’re using [Carthage](http://github.com/Carthage/Carthage), add EmojiKit to your `Cartfile`:
7+
```
8+
github "dasmer/EmojiKit"
9+
```
10+
11+
Otherwise, if you're using [Cocoapods](http://cocoapods.org), add EmojiKit to your `Podfile`:
12+
```
13+
pod 'EmojiKit', '~> 1.0'
14+
```
15+
16+
Usage
17+
-----
18+
##### 1. Create an EmojiFetcher instance variable.
19+
```
20+
let fetcher = EmojiFetcher()
21+
```
22+
##### 2. Use EmojiFetcher's `query` function to get an array of `Emoji` structs that match the given search string.
23+
```
24+
fetcher.query("food") { emojiResults in
25+
// Use emojiResults
26+
}
27+
```
28+
29+
Contributing
30+
------------
31+
32+
The best way to contribute is by submitting a pull request. You can also submit a [new Github issue](https://github.com/dasmer/EmojiKit/issues/new) if you find bugs or have questions. :octocat:
33+
34+
Please make sure to follow the general coding style and add test coverage for new features!

0 commit comments

Comments
 (0)