Readme

Readme blomstra/readme

Display extension README file in the admin panel

Readme

License Latest Stable Version

A Flarum extension.

Features

Adds a README button to each extension page in the Flarum admin panel. For each extension that has either a README.md or README file, the contents will be rendered in a modal for easy access to documentation for the version installed.

image

image

Installation

For Blomstra clients, this extension is pre-installed and updated automatically.

Otherwise, install manually with composer:

composer require blomstra/readme

Updating

composer update blomstra/readme

Links

Versions

  • Works with Flarum v1.8.9.

  • Unlikely to work with Flarum v2.0.0-beta.6.

  • Last version 0.2.1 tagged.

  • 4 more versions.
  • Extension created.