1# emoji :rocket: :school_satchel: :tada:
 2`emoji` is a minimalistic emoji library for Go. It lets you use emoji characters in strings.
 3
 4Inspired by [spatie/emoji](https://github.com/spatie/emoji)
 5
 6## Install :floppy_disk:
 7``` bash
 8go get github.com/enescakir/emoji
 9```
10
11## Usage :surfer:
12```go
13    package main
14    
15    import (
16        "fmt"
17    
18        "github.com/enescakir/emoji"
19    )
20    
21    func main() {
22        fmt.Printf("hello %v from %v\n", emoji.WavingHand, emoji.FlagsForFlagTurkey)
23        fmt.Printf("different skin tones. default: %v light: %v dark: %v\n", 
24            emoji.ThumbsUp,
25            emoji.OkHand.Tone(emoji.Light),
26            emoji.CallMeHand.Tone(emoji.Dark),
27        )
28        fmt.Printf("emoji with multiple skins: %v\n", emoji.PeopleHoldingHands.Tone(emoji.Light, emoji.Dark))
29    }
30
31    /* OUTPUT
32
33        hello 👋 from 🇹🇷
34        different skin tones. default: 👍 light: 👌🏻 dark: 🤙🏿
35        emoji with multiple skins: 🧑🏻‍🤝‍🧑🏿
36
37    */
38    
39```
40
41This package contains Full Emoji List v12.0 based on [https://unicode.org/Public/emoji/12.0/emoji-test.txt](https://unicode.org/Public/emoji/12.0/emoji-test.txt).
42
43## Testing :hammer:
44``` bash
45go test
46```
47
48## Todo :pushpin:
49* Add `godoc`
50* Add country code to flag emoji converter
51* Add badges to README
52* Add tests
53* Add emoji constant generator
54
55## Contributing :man_technologist:
56I am accepting PRs that add characters to the class.
57Please use [this list](http://unicode.org/emoji/charts/full-emoji-list.html) to look up the unicode value and the name of the character.
58
59## Credits :star:
60- [Enes Çakır](https://github.com/enescakir)
61
62## License :scroll:
63The MIT License (MIT). Please see [License File](LICENSE.md) for more information.