<commit_before>[![Build Status](https://travis-ci.org/andela-fokosun/Checkpoint3.svg)](https://travis-ci.org/andela-fokosun/Checkpoint3)

# Emojis4Devs REST API

Emojis4Devs is a RESTful API that allows you **get**, **find**, **update** or **delete** any emoji of your choosing. The API employs the use of simple token based authentication.

##Usage

Working on a client project or on a side project? There are many fun stuff you can do with Emojis4Devs e.g.

**To have a listing of all the created emojis, you need to hit the `emojis` endpoint.**

So you can for example run a GET request in [Postman](https://www.getpostman.com/) like so:

        GET: https://emojisfordevs.herokuapp.com/emojis

        GET: https://emojisfordevs.herokuapp.com/emojis/1

Say you want emojis of a particular category, `skype` for example:

        GET: https://emojisfordevs.herokuapp.com/category/skype

output:

            [
                {
                    "id": 8,
                    "name": "<NAME>",
                    "emojichar": "☹",
                    "keywords": "emotion",
                    "category": "skype",
                    "createdat": "2015-11-27 11:02:21",
                    "updatedat": "2015-11-27 11:15:10",
                    "createdby": "test"
                },
                {
                    "id": 9,
                    "name": "<NAME>",
                    "emojichar": "☹☹",
                    "keywords": "emotions",
                    "category": "skype",
                    "createdat": "2015-11-27 11:48:01",
                    "updatedat": "2015-11-27 11:48:01",
                    "createdby": "test"
                }
            ]

There you go, all the emojis under the **skype** category delivered to you in JSON format!

![alt text](templates/screenshots/get_all_emojis.jpg "Description goes here")

See full documentation [here](https://emojis4devs.herokuapp.com/) for the various endpoints and how to consume them.

##Contributing<commit_msg>add image screenshts to readme<commit_after>[![Build Status](https://travis-ci.org/andela-fokosun/Checkpoint3.svg)](https://travis-ci.org/andela-fokosun/Checkpoint3)

# Emojis4Devs REST API

Emojis4Devs is a RESTful API that allows you **get**, **find**, **update** or **delete** any emoji of your choosing. The API employs the use of simple token based authentication.

##Usage

Working on a client project or on a side project? There are many fun stuff you can do with Emojis4Devs e.g.

**First thing you have to do is to register. So hit the register route like so:

    ![alt text](templates/screenshots/user_registration.jpg "Description goes here")

Supply a `username` and a `password` and you are good to go.

Next thing you want to do is to login:

    ![alt text](templates/screenshots/user_login.jpg "Description goes here")

**To have a listing of all the created emojis, you need to hit the `emojis` endpoint.**

So you can for example run a GET request in [Postman](https://www.getpostman.com/) like so:

![alt text](templates/screenshots/get_all_emojis.jpg "Description goes here")

Say you want emojis of a particular category, `skype` for example:

        GET: https://emojisfordevs.herokuapp.com/category/skype

output:

            [
                {
                    "id": 8,
                    "name": "<NAME>",
                    "emojichar": "☹",
                    "keywords": "emotion",
                    "category": "skype",
                    "createdat": "2015-11-27 11:02:21",
                    "updatedat": "2015-11-27 11:15:10",
                    "createdby": "test"
                },
                {
                    "id": 9,
                    "name": "<NAME>",
                    "emojichar": "☹☹",
                    "keywords": "emotions",
                    "category": "skype",
                    "createdat": "2015-11-27 11:48:01",
                    "updatedat": "2015-11-27 11:48:01",
                    "createdby": "test"
                }
            ]

There you go, all the emojis under the **skype** category delivered to you in JSON format!

See full documentation [here](https://emojis4devs.herokuapp.com/) for the various endpoints and how to consume them.

##Contributing
{'fraction_non_alphanumeric': 0.12161844271936015, 'fraction_numerical': 0.030345800988002825, 'mean_word_length': 2.011331444759207, 'pattern_counts': {'":': 32, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 12, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1104739', 'n_tokens_mistral': 1398, 'n_tokens_neox': 1244, 'n_words': 392}