docs: 📝 update docs

Author: manh-vv

docs/index.md

@@ -1,37 +1,74 @@
-## Welcome to GitHub Pages
+# Eosio name to uint64
 
-You can use the [editor on GitHub](https://github.com/manh-vv/eosjs-name/edit/master/docs/index.md) to maintain and preview the content for your website in Markdown files.
+[![NPM](https://img.shields.io/npm/v/eosjs-account-name.svg)](https://www.npmjs.org/package/eosjs-account-name)
+[![Build Status](https://travis-ci.org/manh-vv/eosjs-name.svg?branch=master)](https://travis-ci.org/manh-vv/eosjs-name)
+[![codecov](https://codecov.io/gh/manh-vv/eosjs-name/branch/master/graph/badge.svg?token=WLVN5CZT6Q)](https://codecov.io/gh/manh-vv/eosjs-name)
 
-Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/manh-vv/eosjs-name)
 
-### Markdown
+```sh
+npm i eosjs-account-name
+```
+
+```sh
+yarn add eosjs-account-name
+```
+
+## From name to uint64
+
+Here is [how eosio account name is computed to uint64](https://github.com/EOSIO/eos/blob/master/libraries/chain/include/eosio/chain/name.hpp#L21).
+
+```text
+"eosio",
+"eosio.msig",
+"eosio.token",
+
+---- 6138663577826885632
+---- 6138663587900751872
+---- 6138663591592764928
+```
 
-Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
+## From uint64 to name
 
-```markdown
-Syntax highlighted code block
+Source https://github.com/EOSIO/eos/blob/master/libraries/chain/name.cpp#L19
 
-# Header 1
-## Header 2
-### Header 3
+## Example
 
-- Bulleted
-- List
+Try on run-kit https://npm.runkit.com/eosjs-account-name
 
-1. Numbered
-2. List
+```javascript
+const eosjsAccountName = require('eosjs-account-name');
+const n = eosjsAccountName.nameToUint64('eosio');
 
-**Bold** and _Italic_ and `Code` text
+console.log('eosio to uint64: ' + n);
 
-[Link](url) and ![Image](src)
+console.log('uint64 to name: ' + eosjsAccountName.uint64ToName(n));
 ```
 
-For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
+### Parse symbol name
+
+[symbol.test.js](./__tests__/symbol.test.js)
 
-### Jekyll Themes
+```javascript
+const { symbol, nameToUint64 } = require('eosjs-account-name');
 
-Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/manh-vv/eosjs-name/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
+/**
+ * cleos -u https://eos.greymass.com get scope eosio.token -t stat
+ */
+const name = '........ehbo5';
+const uint64 = nameToUint64(name);
+const symbolName = symbol.toName(uint64);
+
+// expect(symbolName).toEqual('EOS');
+```
 
-### Support or Contact
+## Note on random eosio name
+
+In case you want to generate a random name, I suggest you use [`nanoid`](https://zelark.github.io/nano-id-cc/).
+
+```javascript
+const generate = require('nanoid/generate');
+const alphabet = '.12345abcdefghijklmnopqrstuvwxyz';
+generate(alphabet, 12); //=> "nc4zs1yyg.jx"
+```
 
-Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.