Skip to content

A platform for community discussion. Free, open, simple.

DEV: Update discourse-details description and README (#40786)

Martin Brennan1620a74bd4cb
diff --git a/plugins/discourse-details/README.md b/plugins/discourse-details/README.md
index 13ea64319e8..1c4795db119 100644
--- a/plugins/discourse-details/README.md
+++ b/plugins/discourse-details/README.md
@@ -1,8 +1,10 @@
### discourse-details
-HTML 5.1 `<details>` polyfill for [Discourse](https://www.discourse.org).
+Adds collapsible `[details]` sections to posts in [Discourse](https://www.discourse.org).
-NOTE: Does not work on IE9, but we don't support IE9 as of Jan 1 2016.
+The plugin registers the `[details]` BBCode tag, a composer toolbar button and
+rich editor support, and handles rendering these sections in emails and
+excerpts. It renders to the native HTML `<details>`/`<summary>` elements.
## Usage
@@ -13,11 +15,6 @@ For example:
I watched the murder mystery on TV last night. [details=Who did it?]The butler did it[/details].
```
-## Installation
-
-Follow our [Install a Plugin](https://meta.discourse.org/t/install-a-plugin/19157) howto, using
-`git clone https://github.com/discourse/discourse-details.git` as the plugin command.
-
## Issues
If you have issues or suggestions for the plugin, please bring them up on [Discourse Meta](https://meta.discourse.org).
diff --git a/plugins/discourse-details/plugin.rb b/plugins/discourse-details/plugin.rb
index 570fddc30c4..d15d0ab9254 100644
--- a/plugins/discourse-details/plugin.rb
+++ b/plugins/discourse-details/plugin.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true
# name: discourse-details
-# about: HTML5.1 Details polyfill for Discourse
+# about: Adds collapsible `[details]` sections to posts
# version: 0.4
# authors: Régis Hanol
# url: https://github.com/discourse/discourse/tree/main/plugins/discourse-details