3.1.1 update

.versions

@@ -11,7 +11,7 @@ diff-sequence@1.0.7
 ecmascript@0.7.3
 ecmascript-runtime@0.3.15
 ejson@1.0.13
-emojione:emojione@3.0.3
+emojione:emojione@3.1.0
 html-tools@1.0.11
 htmljs@1.0.11
 id-map@1.0.9

INSTALLATION.md

@@ -3,8 +3,8 @@
 We've teamed up with [JSDelivr](http://www.jsdelivr.com/#!emojione) to provide a simple way to install these emoji on any javascript-enabled website. Add the following script and stylesheet links to the head of your webpage:
 
 ```
-<script src="https://cdn.jsdelivr.net/emojione/3.0.3/lib/js/emojione.min.js"></script>
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/emojione/3.0.3/extras/css/emojione.min.css"/>
+<script src="https://cdn.jsdelivr.net/emojione/3.1.1/lib/js/emojione.min.js"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/emojione/3.1.1/extras/css/emojione.min.css"/>
 ```
 
 Quick installs can also be done using NPM and Bower (for the Javascript toolkit) or Composer (for the PHP toolkit). **If you wish to serve image assets locally you'll need to install [emojione-assets](https://www.github.com/emojione/emojione-assets) and include the pngs and/or sprites into your project.** Many of our [demos](https://demos.emojione.com/latest/) use assets locally simply by pointing the `imagePathPNG` variable to your local asset location.

UPGRADE.md

@@ -37,21 +37,28 @@ Replaced by ‘examples’. Contains code snippets of each of the functions prev
  - primary key is now *base code point* rather than shortname
 	- base code point is the full unicode code point minus VS16 and ZWJ
 	- base code point is used as an identifier for emoji file names (PNG) as well as within sprites (CSS)
+ - **name** (str)
+ - **unicode_version** (num) - floating-point number indicating initial Unicode release
+ - **category** (str) - key for `category` property in `emoji_categories.json`
+ - **emoji_order** (num) is now simply **order** (num)
+ - **display** (num) determines whether an emoji should be shown on a keyboard
+ - **shortname** (str) colon-encapsulated, snake_case representation of the emoji name
+ - **aliases** (array) is now **shortname_alternates** (array) alternative (including previously-used) shortnames
+ - **aliases_ascii** (array) is now **ascii** (array)
+ - **diversity** (str) is either `null` or the base code point of the corresponding Fitzpatrick Emoji Modifier
+ - **diversities** (array) contains the base code points of the diversity children for a diversity parent (non-diverse, diversity base)
+ - **gender** (str) is either `null` or the base code point of the corresponding male/female emoji symbol
+ - **genders** (array) contains the base code points of the gender children for a gender parent (gender-neutral, gender base)
  - **unicode** (str) and **unicode_alt** (str) are depricated. code points are now organized within **code_points** (array)
  	- **base** (str) is identical to the primary key
+ 	- **fully_qualified** (str) represents code point according to [this Unicode documentation](http://unicode.org/Public/emoji/5.0/emoji-test.txt)
+ 	- **non_fully_qualified** (str) derived from same documentation as FQ. NFQ code point convention is used for PNG file names in font file builds
 	- **output** (str) is the recommended code point to use for conversion to native unicode
 	- **match_default** (array) contains one or more code points used to identify native unicode
 	- **match_greedy** (array) contains one or more code points used to identify potential native unicode variants
 		- note: the match_greedy code point(s) may replace non-emoji variants producing undesired results
 	- **decimal** (str) replaces **code_decimal** (str)
- - **emoji_order** (int) is now simply **order** (int)
- - **display** (int) determines whether an emoji should be shown on a keyboard
- - **aliases** (array) is now **shortname_alternates** (array)
- - **aliases_ascii** (array) is now **ascii** (array)
- - **diversity** (str) is either `null` or the base code point of the corresponding Fitzpatrick Emoji Modifier
- - **diversities** (array) contains the base code points of the diversity children for a diversity parent (non-diverse, diversity base)
- - **gender** (str) is either `null` or the base code point of the corresponding male/female emoji symbol
- - **genders** (array) contains the base code points of the gender children for a gender parent (gender-neutral, gender base)
+ - **keywords** (array)
 
 **EMOJI_STRATEGY.JSON (updated)**
  - primary key is now *base code point* rather than short name

USAGE.md

@@ -2,10 +2,11 @@
 
 ## Object Properties
 
-Both PHP and JavaScript libraries now have wider range of available properties to customize your experience. The following are available for both libraries.
+Both PHP and JavaScript libraries now have wider range of available properties. The following are available for both libraries.
 
- - `emojiVersion` (str) - Used only to direct CDN path. This is a 2-digit version (e.g. '3.0'). Not recommended for usage below 3.0.0.
+ - `emojiVersion` (str) - Used only to direct CDN path. This is a 2-digit version (e.g. '3.1'). Not recommended for usage below 3.0.0.
  - `emojiSize` (str) **Default: `32`** - Used only to direct CDN path for non-sprite PNG usage. Available options are '32', '64', and '128'.
+ - `imagePathPNG` (str) - Defaults to CDN (jsdelivr) path. Setting as alternate path overwrites `emojiSize` option.
  - `greedyMatch` (bool) **Default: `false`** - When `true`, matches non-fully-qualified Unicode values.
  - `imageTitleTag` (bool) **Default: `true`** - When `false`, removes title attribute from <img> tag.
  - `sprites` (bool) **Default: `false`** - When `true`, sprite markup will be used. Sprite CSS and PNG assets must be additionally included.

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "emojione",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "main": [
     "extras/css/emojione.css",
     "lib/js/emojione.js"

extras/fonts/README.md

@@ -6,7 +6,7 @@ There's no better way to port our emoji into your device than through a native f
 https://github.com/Ranks/emojione/raw/master/extras/fonts/emojione-android.ttf
 
   * Compatible with rooted Android devices and Linux.
-  * Updated May 23, 2017
+  * Updated July 6, 2017
   * Developers using the font within their app, please review [this issue](https://github.com/Ranks/emojione/issues/385) regarding proper display of digits.
 
 Android Setup Help:
@@ -37,7 +37,7 @@ https://github.com/Ranks/emojione/raw/master/extras/fonts/emojione-apple.ttc
   * Rename font to Apple Color Emoji.ttf for Mac OSX.
   * Rename font to AppleColorEmoji@2x.ttf for iOS, jailbreak required.
   * Known Issue: On Mac OSX, emoji may display significantly smaller than normal (system wide).
-  * Updated July 3, 2017
+  * Updated July 8, 2017
 
 Mac OS Instructions:
 Using the latest OS (El Capitan), I was able to load this emoji file in less than a minute.  The original emoji ttf is located in system/library/fonts, do not touch this.  You can safely upload the renamed file (from emojione-apple.ttf, to Apple Color Emoji.ttf) to the /library/fonts folder.  That file will override the default.  This was my experience, but yours may vary.  If someone could create a video and/or web-site guide, we'd gladly link to it.