Skip to content
This repository was archived by the owner on Apr 28, 2020. It is now read-only.

Commit 6787708

Browse files
committed
Readme and package update
1 parent e525e70 commit 6787708

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,48 @@ Be patient with us, its our first field :). And don't be mad that it uses Vue.js
99
## TODO:
1010
- Ui design + css @krisak + @mightybart
1111
- Documentation @krisak
12+
13+
14+
## Usage
15+
16+
As any field in blueprint:
17+
```yaml
18+
table:
19+
label: table
20+
type: tablex
21+
options:
22+
maxColumns: 10
23+
minColumns: 3
24+
header: false
25+
```
26+
27+
Options are not required. Defaults are:
28+
```yaml
29+
maxColumns: 10
30+
minColumns: 1
31+
header: false
32+
```
33+
34+
35+
36+
## Installation
37+
To install the plugin, please put it in the `site/plugins` directory.
38+
The plugin folder must be named `tablex`.
39+
40+
```
41+
site/plugins/
42+
tablex/
43+
tablex.php
44+
...
45+
```
46+
47+
### Download
48+
Link to latest version https://github.com/floriankarsten/kirby-tablex/releases/latest
49+
50+
### With Kirby CLI
51+
```kirby plugin:install floriankarsten/kirby-tablex```
52+
53+
### With Git
54+
```git clone https://github.com/floriankarsten/kirby-tablex/releases.git tablex```
55+
You can of course have it as submodule. There won't be many updates.
56+

package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "kirby-tablex",
3+
"description": "Kirby table field plugin",
4+
"author": "Florian Karsten <[email protected]>",
5+
"version": "0.1",
6+
"type": "kirby-field",
7+
"license": "MIT"
8+
}

0 commit comments

Comments
 (0)