Skip to content

Commit 15957d6

Browse files
committed
Add README text
1 parent 2ee6e82 commit 15957d6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
11
# GridShow
22
XenForo 2.x AddOn to show a grid of tiles in homepage.
3+
4+
![gridshow](https://github.com/InforgeNet/GridShow/wiki/images/gridshow.png)
5+
6+
## Installation
7+
8+
Download the [latest
9+
release](https://github.com/InforgeNet/GridShow/releases/latest) and follow the
10+
instructions of [installing an add-on for
11+
XenForo2](https://xenforo.com/xf2-docs/manual/add-ons/)
12+
13+
For development, fork the repository and then clone the fork in the
14+
`src/addon/Inforge/GridShow` directory of your development board.
15+
16+
## Usage
17+
18+
In the admin panel you will find the _GridShow_ menu. Here, you can add new
19+
tiles to display to your users. You can set as many tiles as you want but the
20+
add-on will display only the first 12.
21+
22+
Users must have the `View tiles` permission set to view the tiles in homepage
23+
(default enabled). Admins must have the `Manage GridShow tiles` permission set
24+
to view the _GridShow_ menu in the admin panel.
25+
26+
From `Appearence > Style properties > GridShow Widget` you can modify the style
27+
of the addon.
28+
29+
### Help
30+
31+
If you have a problem with this addon, open an
32+
[issue](https://github.com/InforgeNet/GridShow/issues/new).

0 commit comments

Comments
 (0)