Skip to content

Commit

Permalink
[DEV] Updates README to with clearer information on Right Sidebar Blo…
Browse files Browse the repository at this point in the history
…cks (discourse#597)

* Updates README to with clearer information on Right Sidebar Blocks
  • Loading branch information
brrusselburg authored Aug 9, 2024
1 parent 40d4c65 commit 8491b76
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,7 @@ Install the plugin and switch to the discourse root(not the plugin directory).
# Collect all holiday regions into assets/javascripts/lib/regions.js
bin/rails javascript:update_constants
```

### Interactions with Other Plugins

You can use the an element of this component with [Right Sidebar Blocks](https://github.com/discourse/discourse-right-sidebar-blocks). You'll want to ensure the desired route is enabled via the `events calendar categories` setting. In Right Sidebar Block's settings, the block name will be `upcoming-events-list`, and the params use this [syntax](https://momentjs.com/docs/#/displaying/format/), for example `MMMM D, YYYY`.

0 comments on commit 8491b76

Please sign in to comment.