Replace README.txt with README.md format

An updated patch version for 2.x-dev.

Hi Chris64,

I applied your patch #6 and I noticed that the README.md file is not following the Drupal README.md template → and some required README sections are missing, for your reference below is the README.md sections that Drupal requires

Project name and introduction (required)
Table of contents (optional)
Requirements (required)
Recommended modules (optional)
Installation (required, unless a separate INSTALL.md is provided)
Configuration (required)
Troubleshooting & FAQ (optional)
Maintainers (optional)

and below is the README.md content that your patch created

# DataTables Module

## INTRODUCTION

The DataTables module integrates the DataTables jQuery plugin into Drupal which
provides advanced interaction controls to HTML tables such as dynamic
pagination, on-the-fly filtering, and column sorting.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/datatables

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/search/datatables

 * For full documentation and examples, visit the DataTables plugin page:
   http://datatables.net

## INSTALLATION

 * Module: Install as you would normally install a contributed Drupal module.
   See: https://www.drupal.org/docs/extending-drupal/installing-modules
   for further information.
   Install with composer via `composer require 'drupal/datatables:^2.0'`,
   then enable the module as usal.

 * Plugin: Download the latest DataTables jQuery plugin version 1.10.
   See: https://datatables.net/download/index
   Download with Composer via `composer require 'datatables/datatables:^1.10'`
   and move the contents of the vendor/datatables directory into the
   libraries/datatables directory.
   Copy to libraries from vendor with Composer:
   Edit the composer.json file of your website and under the "extra" entry and
   the "installer-paths" subentry and juste after line
            "web/libraries/{$name}": [
   add,
                "datatables/datatables",
   And install mnsami/composer-custom-directory-installer via
   `composer require 'mnsami/composer-custom-directory-installer:^2.0'`
   From now, `composer update` command will update datatables libraries.

## USAGE

 * Create a new view at Structure » Views » Add new view

 * Select DataTables as the view style.

 * Add fields to show in the table.

Please check,
Thank you

You are right @clarkssquared! A better version.

Hi Chris64,

I applied your patch #8 and I confirmed that the README.md file looks good,

# DataTables

   The DataTables module integrates the DataTables jQuery plugin into Drupal which
   provides advanced interaction controls to HTML tables such as dynamic
   pagination, on-the-fly filtering, and column sorting.

   - For a full description of the module, visit the project page:
      <https://www.drupal.org/project/datatables>
   - To submit bug reports and feature suggestions, or to track changes:
      <https://www.drupal.org/project/issues/search/datatables>
   - For full documentation and examples, visit the DataTables plugin page:
      <http://datatables.net>


   ## Requirements

   This module requires the following library (see Installation):
   - [DataTables library](https://datatables.net/download/index)


   ## Installation

   - Module:
      Install as you would normally install a contributed Drupal module.
      See: [Installing Modules](https://www.drupal.org/docs/extending-drupal/installing-modules)
      for further information.
      Install with composer via `composer require 'drupal/datatables:^2.0'`,
      then enable the module as usal.
   - Plugin:
      Download the latest DataTables jQuery plugin version 1.10.
      See: [DataTables library](https://datatables.net/download/index)
      Download with Composer via `composer require 'datatables/datatables:^1.10'`
      and move the contents of the vendor/datatables directory into the
      libraries/datatables directory.
      Copy to libraries from vendor with Composer:
      Edit the `composer.json` file of your website and under the "extra" entry and
      the "installer-paths" subentry and juste after line
               "web/libraries/{$name}": [
      add,
                  "datatables/datatables",
      And install `mnsami/composer-custom-directory-installer` via
      `composer require 'mnsami/composer-custom-directory-installer:^2.0'`
      From now, `composer update` command will update datatables libraries.


   ## Configuration

   - Create a new view at Structure » Views » Add new view
   - Select DataTables as the view style.
   - Add fields to show in the table.

Moving this to RTBC, thank you

Thank you @clarkssquared!

@Chris64 could you please prepare this as MR?

Then I'd be happy to merge it!

@Anybody, problem met for a MR: the datatables-3319886/2.x does not correspond to the origin/2.x (D10 dev-2.x version). It is the D9 version. No branch in datatables-3319886 seems correspond to dev-2.x. (The first one on 2.x gives merge error. The second one is wrong since from master, an outdated version.)

MR ready!

RTBC for MR!12 - still the README.md could then need more love and input from the community to help beginners. Perhaps add a novice-tagged follow-up?

@Anybody, you mean create a follow-up issue from this one? Before closing. Why not. If better could be done with the README.

Closed over 20 issues today and pushed about 8 RTBCs and this is the last in the list to get a final 2.0.1 relase tonight. Thanks @ all for the hard work on this.

Merged and queued for upcoming release.

Automatically closed - issue fixed for 2 weeks with no activity.