Replace README.txt with README.md

Created on 9 January 2024, about 1 year ago
Updated 9 June 2024, 10 months ago

Problem/Motivation

We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation.

📌 Task
Status

Fixed

Version

1.0

Component

Code

Created by

🇮🇳India aman_lnwebworks

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @aman_lnwebworks
  • Merge request !1Update README.txt → (Open) created by aman_lnwebworks
  • Status changed to Needs work about 1 year ago
  • 🇮🇳India ravi kant Jaipur

    @aman_lnwebworks
    The README.md file is empty in MR.

  • Assigned to nitin_lama
  • Status changed to Needs review about 1 year ago
  • Issue was unassigned.
  • Status changed to RTBC about 1 year ago
  • 🇵🇭Philippines clarkssquared

    Hi

    I applied MR !1 and I confirmed that it replaces README.txt with README.md file and its content is as per drupal README template,

    # Anime
    
    This module integrates the [Anime.js](https://github.com/juliangarnier/anime)
    library.
    
    Anime.js (/ˈæn.ə.meɪ/) is a lightweight JavaScript animation library with a
    simple, yet powerful API.
    
    It works with CSS properties, SVG, DOM attributes and JavaScript Objects.
    
    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/form_mode_control).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/form_mode_control).
    
    
    ## Table of contents
    
    - Requirements
    - Installation
    - Features
    - Configuration
    - Maintainers
    
    
    ## Requirements
    
    Download [Anime.js](https://github.com/juliangarnier/anime/archive/master.zip)
    library.
    
    
    ## Installation
    
    1. Download 'Anime' module archive
       - https://www.drupal.org/project/anime
    1. Extract and place it in the root modules directory i.e.
       /modules/anime or /modules/contrib/anime
    1. Create a libraries directory in the root, if not already there i.e.
       /libraries
    1. Create a 'anime' directory inside it i.e.
       /libraries/anime
    1. Download 'Anime' library
       - https://github.com/juliangarnier/anime/archive/master.zip
    1. Place it in the /libraries/anime directory i.e.
       /libraries/anime/lib/anime.min.js
    1. Now, enable 'Anime' module.
    
    
    ## Features
    
    'jQuery Anime' plugin is:
    
    - Lightweight
    - Easy to use
    - Powerful
    - Responsive
    - Customizable
    
    
    ## Usage
    
    Here is an Anime example:
    ```
    anime({
      targets: 'div',
      translateX: 250,
      rotate: '1turn',
      backgroundColor: '#FFF',
      duration: 800
    });
    ```
    Check official Anime.js documentation for more information:
      - https://animejs.com/documentation/
    
    
    ## Configuration
    
    1. Download Anime.js library, Follow INSTALLATION in above.
    1. Enable "Anime" module, Follow INSTALLATION in above.
    1. Add script to your theme/module ja file, Follow USAGE in above.
    1. Enjoy that.
    
    
    ## Maintainers
    
    - Mahyar Sabeti - [mahyarsbt](https://www.drupal.org/u/mahyarsbt)
    
  • Status changed to Fixed 10 months ago
  • Status changed to Fixed 10 months ago
Production build 0.71.5 2024