Replace README.txt with README.md

Hi

Your MR !1 is cannot be applied, please look at below

➜  otp_auth git:(master) ✗ curl https://git.drupalcode.org/project/otp_auth/-/merge_requests/1.diff | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   101    0   101    0     0    193      0 --:--:-- --:--:-- --:--:--   195
  I can't seem to find a patch in there anywhere.
➜  otp_auth git:(master) ✗ curl https://git.drupalcode.org/project/otp_auth/-/merge_requests/1.diff | git apply -v
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   101    0   101    0     0    208      0 --:--:-- --:--:-- --:--:--   211
Skipped patch 'README.txt => README.md'.
➜  otp_auth git:(master) ✗ 

I also noticed that the MR will just change the filename of the README file and the existing README in the module doesn't follow the Drupal README.md template →

So replace it with new README.md file that follows drupal standards.

gajanan.wasnik → made their first commit to this issue’s fork.

Hi

I applied MR !1 and I confirmed that it creates README.md according to Drupal's template.

The README content:

# OTP Auth

This module will allow you to register/login to a site just using mobile
number/OTP sent to the provided mobile number.

For a full description of the module, visit the
[project page](https://www.drupal.org/project/otp_auth).

Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/otp_auth).

## Table of contents

- Requirements
- Installation
- Configuration
- Maintainers
- Queue and Cron
- Use OTP Auth as a service


## Requirements

- sms and sms_user modules that are part of smsframework module.
- basic_auth, restui, rest and serialization (Only if you want to use 
  OTP Auth as a service)

## Installation

OTP Auth can be installed like any other Drupal module.
Place it in the modules directory for your site and enable it
on the `admin/modules` page or 
see [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).

## Configuration

Once the module is installed, a link 'OTP Auth Settings' will appear on
   `/admin/config` page under 'People'.

1. Go to `/admin/config/people/otp_auth` to configure OTP Auth related
     settings
  - Enable 'Activate OTP Auth' to enable OTP Auth.
  - Choose OTP Platform.
      ZzzWith 'SMS framework', you can use any supported gateway to send OTP.
  - If you want to purge users who have been blocked / not logged-in for a
    specific number of days, enable the provided checkbox and enter number
    of days.
  - If you want to purge blocked or never logged-in users at any moment,
    click on tab 'OTP Auth - purge users'
    (/admin/config/people/otp_auth/user_purge) and press button
    'Purge users'.

1. Place the 'OTP Auth link' block:
  - Go to `/admin/structure/block` and place 'OTP Auth link' block to your
    preferred region.
  - The link block will be shown only to anonymous users and if
    'Activate OTP Auth' is enabled.

In addition, also configure settings related to smsframework module.

  1. Go to `/admin/config/smsframework/settings` to configure 'Fallback gateway'
    and 'Phone verification path'.
  1. Go to `/admin/config/smsframework/gateways` to add new gateway.
  1. Go to `/admin/config/smsframework/phone_number` to add phone number settings:
    - Click on 'Add phone number settings' button.
    - Select 'user' bundle.
    - Under 'Field mapping' -> 'Phone number' select 'Create a new telephone
      field'.
    - You can choose to keep everything else as-is.

If you want to use OTP Auth as a service:

  1. Go to `/admin/config/services/rest`.
  1. Enable 'Generate OTP', 'Submit OTP' and 'Logout OTP' resources.

## Maintainers

- Amir Koulivand - [vispa](https://www.drupal.org/u/vispa)

### Queue and Cron

Considering the fact that, on few sites, there could be hundreds of users who
would try to login through OTP, our module will not send OTP directly.
Instead, it will Queue the OTP and will be sent on next cron run.

### Use OTP Auth as a service

You can use functionalities of this module as a service, so that it can be
  used with your mobile app, for example.

Below are the urls and parameters that needs to be passed to those urls:
1. URL: `/otp/generate`
   parameters: mobile_number
1. URL: `/otp/login`
   parameters: otp and mobile_number
1. URL: `/otp/logout`
   parameters: session_id and mobile_number