somemoji 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9226ef38d541403c6c1e567087fc02d100dde798
-  data.tar.gz: 94b439e4704fc2d98a3ae66de9bc2e7498b9562c
+  metadata.gz: 8cbb1fdec97e44218fc0edf827f29ce35da6b5fb
+  data.tar.gz: b5f523fe41cfea4776dee0fecda5242f47240403
 SHA512:
-  metadata.gz: 37b854b7b285a50c60c8300497cb5126210ce31f57aa585b8033e0040ef5f728b455ce12af1381171c8e1a02c116dd3549c00a0be51a25d27f902381ad513115
-  data.tar.gz: a935436131de499d333c753f74cc9f8587d558c51fd51a4acbb9dc8d5d440f62a131a3764a962a72cfa5f4d412ba1189ed4227d1c42755e4e6c70d170a1a86a6
+  metadata.gz: cbd284b04f460b93f1eddf9ac4bc542d4aef8186788c6d92b263b0225e9f1edd170d5d8f7b18e560afee94565e710e772dc3b3c2fef0b48b05ff0430ed1f9263
+  data.tar.gz: 5223bcfac9f9f319f73aafeb9bcceeb5848780a9bf7eecf32300cc070f714a55c772666d660502b7ad654c2f1db56a99ea24b9205f36c87f987780a58da2c292

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## v0.2.0
+
+- Support Apple emoji
+- Implement emoji extractors for Apple, EmojiOne, and Twemoji
+
+## v0.1.0
+
+- 1st Release :tada:

data/README.md

@@ -1,7 +1,16 @@
 # Somemoji
 
+[![CircleCI](https://circleci.com/gh/r7kamura/somemoji.svg?style=svg)](https://circleci.com/gh/r7kamura/somemoji)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/github/r7kamura/somemoji)
+
 A grand unified emoji mapper for some emoji providers.
 
+## Supported emoji
+
+- [Apple Emoji](https://support.apple.com/en-us/HT202332)
+- [EmojiOne](http://emojione.com/)
+- [Twemoji](http://twitter.github.io/twemoji/)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,131 +31,6 @@ Or install it yourself as:
 gem install somemoji
 ```
 
-## Usage
-
-### Somemoji.emoji_collection
-
-Returns a `Somemoji::EmojiCollection` instance based on our emoji definitions.
-
-```ruby
-require "somemoji"
-
-Somemoji.emoji_collection.class #=> Somemoji::EmojiCollection
-Somemoji.emoji_collection.count #=> 1794
-Somemoji.emoji_collection.first.class #=> Somemoji::Emoji
-```
-
-### Somemoji::EmojiCollection#find_by_character(character)
-
-Finds a `Somemoji::Emoji` instance from an emoji character (unicode grapheme cluster).
-
-```ruby
-require "somemoji"
-
-Somemoji.emoji_collection.find_by_character("👍").class #=> Somemoji::Emoji
-Somemoji.emoji_collection.find_by_character("👎").class #=> Somemoji::Emoji
-```
-
-### Somemoji::EmojiCollection#find_by_code(code)
-
-Finds a `Somemoji::Emoji` instance from an emoji code.
-
-```ruby
-require "somemoji"
-
-Somemoji.emoji_collection.find_by_code("thumbsup").class #=> Somemoji::Emoji
-Somemoji.emoji_collection.find_by_code("+1").class #=> Somemoji::Emoji
-Somemoji.emoji_collection.find_by_code("undefined_code") #=> nil
-```
-
-### Somemoji::EmojiCollection#+(emoji_collection)
-
-Compounds two `Somemoji::EmojiCollection` into one `Somemoji::EmojiCollection`.
-
-```ruby
-require "somemoji"
-
-custom_emoji_collection = Somemoji.emoji_collection + Somemoji::EmojiCollection.new(
-  [
-    Somemoji::Emoji.new(code: "foo"),
-    Somemoji::Emoji.new(code: "bar"),
-  ]
-)
-custom_emoji_collection.find_by_code("foo").class #=> Somemoji::Emoji
-custom_emoji_collection.find_by_code("bar").class #=> Somemoji::Emoji
-custom_emoji_collection.find_by_code("100").class #=> Somemoji::Emoji
-```
-
-### Somemoji::EmojiCollection#replace_character(string, &block)
-
-Replace emoji characters in a given string with a given block.
+## Documentation
 
-```ruby
-require "somemoji"
-
-Somemoji.emoji_collection.replace_code("I ❤ Emoji") do |emoji|
-  %(<img alt="#{emoji.character}" class="emoji" src="/assets/emoji/#{emoji.code_points.join('-').downcase}.png">)
-end
-#=> 'I <img alt="❤" class="emoji" src="/assets/emoji/2764.png"> Emoji'
-```
-
-### Somemoji::EmojiCollection#replace_code(string, &block)
-
-Replace emoji codes in a given string with a given block.
-
-```ruby
-require "somemoji"
-
-Somemoji.emoji_collection.replace_code("I :heart: Emoji") do |emoji|
-  %(<img alt="#{emoji.character}" class="emoji" src="/assets/emoji/#{emoji.code_points.join('-').downcase}.png">)
-end
-#=> 'I <img alt="❤" class="emoji" src="/assets/emoji/2764.png"> Emoji'
-```
-
-### Somemoji::Emoji.new
-
-Create a new `Somemoji::Emoji` instance from emoji definition data.
-
-```ruby
-require "somemoji"
-
-emoji = Somemoji::Emoji.new(
-  aliases: [],
-  ascii_arts: [],
-  category: "symbols",
-  code_points_alternates: [],
-  code_points: [
-    "1F4AF"
-  ],
-  code: "100",
-  keywords: [
-    "100",
-    "a",
-    "exam",
-    "numbers",
-    "parties",
-    "percent",
-    "perfect",
-    "plus",
-    "quiz",
-    "school",
-    "score",
-    "symbol",
-    "test",
-    "win",
-    "wow"
-  ],
-  name: "hundred points symbol"
-)
-emoji.character #=> "💯"
-```
-
-### Somemoji::Emoji#character
-
-Returns a String representation of an emoji if it has code points.
-
-```ruby
-require "somemoji"
-
-Somemoji.emojis.first.character #=> "💯"
-```
+See API documentation at http://www.rubydoc.info/github/r7kamura/somemoji.