README.md (view raw)
1# emoji :wolf: :evergreen_tree: :school_satchel:
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
7``` bash
8go get github.com/enescakir/emoji
9```
10
11## Usage
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", emoji.ThumbsUp, emoji.OkHand.Tone(emoji.Light), emoji.CallMeHand.Tone(emoji.Dark))
24 fmt.Printf("emoji with multiple skins\n", emoji.PeopleHoldingHands.Tone(emoji.Light, emoji.Dark))
25 }
26
27 /* OUTPUT
28
29 hello 👋 from 🇹🇷
30 different skin tones. default: 👍 light: 👌🏻 dark: 🤙🏿
31 emoji with multiple skins: 🧑🏻🤝🧑🏿
32
33 */
34
35```
36
37This 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).
38
39## Testing
40``` bash
41go test
42```
43
44## Contributing
45We are accepting PRs that add characters to the class.
46Please use [this list](http://unicode.org/emoji/charts/full-emoji-list.html) to look up the unicode value and the name of the character.
47
48## Security
49If you discover any security related issues, please email enes@cakir.web.tr.
50
51## Credits
52- [Enes Çakır](https://github.com/enescakir)
53
54## License
55The MIT License (MIT). Please see [License File](LICENSE.md) for more information.