README.md

# Text Field Formatter Demo Module

Provides three cusotm text field formatters for textfields.

1. Rot13 - Prints the field value with the ROT13 encoding(https://en.wikipedia.org/wiki/ROT13). For example, "Lorem Ipsum" would become "Yberz Vcfhz".
1. Slugify - Converts and prints the field value into a slug using the cocur/slugify package.
1. Tooltip - Shows a tooltip when you hover on the printed field value. Uses qTip2 Javascript library (https://github.com/qTip2/qTip2) to display the tooltip. Tooltip text are randomly generated sentences.

## Installation

### Step 1: Add with Composer:

Please add the following snippet to the repositories section of your Drupal
project's root composer.json file:

    {
        "type": "vcs",
        "url": "https://akhado.wezbyte.com/WezByte-Public/cdesai-tff"
    }

Add the module to your project:

    composer require drupal/cdesai_tff

### Step 2: Enable the Module:

#### Using Drupal Website

1. Navigate to the Extend page (admin/modules) via the Manage administrative menu
1. Locate the module(s) you wish to enable and check the box next to each one
1. Click Install to enable (turn on) the new module(s)

Refer to https://www.drupal.org/docs/extending-drupal/installing-modules#s-step-2-enable-the-module