Merge pull request #178 from muan/three-dot-o

3.0.0

.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: Test dataset
+
+on:
+  push:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 15.x
+      - run: npm ci
+      - run: npm test

.gitignore

@@ -1,2 +1 @@
 node_modules
-simplemap.json

README.md

@@ -1,66 +1,41 @@
-# :book: emojilib [![Travis CI build status](https://img.shields.io/travis/muan/emojilib.svg?style=flat-square)](https://travis-ci.org/muan/emojilib) [![NPM](https://img.shields.io/npm/dt/emojilib.svg?style=flat-square&colorB=fd7463)](https://www.npmjs.com/package/emojilib) [![JavaScript Standard Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square&colorB=f1d04a)](https://github.com/feross/standard)
+# emojilib ![CI status](https://github.com/muan/emojilib/workflows/Test%20dataset/badge.svg?branch=main) [![npm](https://img.shields.io/npm/dt/emojilib.svg?style=flat-square&colorB=fd7463)](https://www.npmjs.com/package/emojilib) [![JavaScript Standard Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square&colorB=f1d04a)](https://github.com/feross/standard)
 
-Emoji keyword library.
+Make emoji searchable with this keyword library.
 
 ## Install
 
-### :package: NPM<br>![](https://img.shields.io/npm/v/emojilib.svg?style=flat-square)
-
 ```
 npm install emojilib --save
 ```
 
 ## Usage
 
 ```javascript
-> var emoji = require("emojilib")
-> emoji.lib
+> require("emojilib")
 {
-  "grinning": {
-    "keywords": ["face", "smile", "happy", "joy"],
-    "char": "😀",
-    "fitzpatrick_scale": false,
-    "category": "people"
-  },
-  "grin": {
-    "keywords": ["face", "happy", "smile", "joy"],
-    "char": "😁",
-    "fitzpatrick_scale": false,
-    "category": "people"
-  },
+  '😀': [
+    'grinning_face',
+    'face',
+    'smile',
+    'happy',
+    'joy',
+    ':D',
+    'grin'
+  ],
+  '😃': [
+    'grinning_face_with_big_eyes',
+    'face',
+    'happy',
+    'joy',
+    'haha',
   ...
 }
+```
 
-> emoji.ordered
-[ 'grinning', 'grimacing', 'grin', 'joy', 'smiley', 'smile', 'sweat_smile', ...]
-
-> emoji.fitzpatrick_scale_modifiers
-[ '🏻', '🏼', '🏽', '🏾', '🏿' ]
-
-> emoji.lib.v.fitzpatrick_scale
-true
-
-> emoji.lib.turtle.fitzpatrick_scale
-false
+If you are looking for the unicode emoji dataset, including version, grouping, ordering, skin tone suppoer, check out [`unicode-emoji-json`](https://github.com/muan/unicode-emoji-json).
 
-> emoji.lib.v.char + emoji.fitzpatrick_scale_modifiers[4]
-'✌🏿'
-```
+## Development
 
-## :electric_plug: Powered by emojilib
+Test with `npm test`.
 
-* [Emoji Searcher](http://emoji.muan.co) – [muan/emoji](https://github.com/muan/emoji)
-* [Megamoji](http://megamoji.muan.co) – [muan/megamoji](https://github.com/muan/megamoji)
-* [Emoji-translate](http://meowni.ca/emoji-translate) - [notwaldorf/emoji-translate](https://github.com/notwaldorf/emoji-translate)
-* [\<emo-ji\> Custom Element](https://github.com/wbinnssmith/emo-ji)
-* [Menubar emoji search: Mojibar](https://github.com/muan/mojibar) – [muan/mojibar](https://github.com/muan/mojibar)
-* [Emoji CLI](https://github.com/muan/emoji-cli) – [muan/emoji-cli](https://github.com/muan/emoji-cli)
-* [Emoji Lookup for Launchbar](https://github.com/jasonrudolph/launchbar-emoji-lookup) – [jasonrudolph/launchbar-emoji-lookup](https://github.com/jasonrudolph/launchbar-emoji-lookup)
-* [commemoji](https://www.npmjs.com/package/commemoji) - [martellaj/commemoji](https://github.com/martellaj/commemoji)
-* [Emoji Stream](https://www.npmjs.com/package/emoji-stream) – [johnelliott/emoji-stream](https://github.com/johnelliott/emoji-stream)
-* [EmojiPanel for Twitter](http://bit.ly/emojipanel) - [danbovey/EmojiPanel](https://github.com/danbovey/EmojiPanel)
-* [mojibrag](https://mojibrag.firebaseapp.com/) - [notwaldorf/mojibrag](https://github.com/notwaldorf/mojibrag)
-* [Emoji Alfred Workflow](https://www.npmjs.com/package/emoji-alfred-workflow) - [janclarin/emoji-alfred-workflow](https://github.com/janclarin/emoji-alfred-workflow)
-* [(Another) Alfred Workflow for Emoji](https://www.alfredforum.com/topic/11126-alfred-emoji-search-emojis-by-name-or-keyword/) - [jsumners/alfred-emoji](https://github.com/jsumners/alfred-emoji)
-* [Emojipasta Generator](http://erikyangs.com/emojipastagenerator/) - [erikyangs/emojipastagenerator](https://github.com/erikyangs/emojipastagenerator)
-* [Emoji Picker](https://emojipicker.app) - [joeattardi/emoji-picker](https://github.com/joeattardi/emoji-picker)
+After upgrading `unicode-emoji-json`, use `npm run upgrade` to add keywords to each new emoji.