From 1be66dcf322700835dabdaca3749b7c7fe2ab8dc Mon Sep 17 00:00:00 2001
From: Sabbir Ahmed <sabbiirr@gmail.com>
Date: Wed, 27 Apr 2016 18:52:38 +0600
Subject: [PATCH] Basic utilities / helpers added to docs

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index add49207..7dc01d5b 100644
--- a/README.md
+++ b/README.md
@@ -252,6 +252,25 @@ twemoji.parse(genericNode, {
 ```
 This will generate urls such `https://twemoji.maxcdn.com/svg/2764.svg` instead of using a specific size based one.
 
+## Utilities
+
+Basic utilities / helpers to convert code points to JavaScript surrogates and vice versa.
+
+#### twemoji.convert.fromCodePoint()
+For given an HEX codepoint, returns UTF16 surrogate pairs.
+```js
+twemoji.convert.fromCodePoint('1f1e8');
+ // "\ud83c\udde8"
+```
+#### twemoji.convert.toCodePoint()
+For given UTF16 surrogate pairs, returns the equivalent HEX codepoint.
+```js
+ twemoji.convert.toCodePoint('\ud83c\udde8\ud83c\uddf3');
+ // "1f1e8-1f1f3"
+ 
+ twemoji.convert.toCodePoint('\ud83c\udde8\ud83c\uddf3', '~');
+ // "1f1e8~1f1f3"
+```
 
 ## Tips