Skip to content

Commit 23c3cbf

Browse files
committed
Update readme
1 parent f8ace7a commit 23c3cbf

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed
File renamed without changes.
File renamed without changes.

readme.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ Auto Git is a Kirby CMS plugin that commits to a Git repo every time content is
99
- Panel widget for pushing/pulling manually
1010
- Localized commit messages
1111
- Uses panel user as commit author
12+
- Triggers pull and push events
1213

1314
## Requirements
14-
- Git 1.8.5+
15+
- Git
1516
- Kirby 2.3.0+
1617
- PHP 5.6+
1718

@@ -111,6 +112,8 @@ After that, the following URLs will be available to you:
111112

112113
> Don't forget to pass the `secret` as an argument.
113114
115+
> Webhooks we only be enabled when the remote repository defined in the `autogit.remote.name` option exists. Add one by running `git remote add <name> <url>`.
116+
114117
To pull changes on your server every time the remote repo receives a new push, go to **your repo** on Bitbucket/Github/Gitlab then navigate to `settings` > `webhooks` > `add webhook` (these steps are almost the same across all providers).
115118

116119
- URL: `https://yousite.com/autogit/pull?secret=MySuperSecret16`
@@ -130,7 +133,7 @@ Change the webhook URL segment to something else. Defaults to `autogit`.
130133
### autogit.panel.user
131134
Defines if Auto Git should use Kirby's panel user name and email as commit author. This will enable you to see who made each change on your Git client of choice or simply by running `$ git log`. **The user must have first name and email set on their account info.**
132135

133-
![User detail](https://raw.githubusercontent.com/pedroborges/kirby-autogit/master/account_info.png)
136+
![User detail](https://raw.githubusercontent.com/pedroborges/kirby-autogit/master/images/account_info.png)
134137

135138
> Options `autogit.user.name` and `autogit.user.email` will be overridden when this is set to `true`.
136139
@@ -143,7 +146,9 @@ Default commit author email. Applied only when the option `autogit.panel.user` i
143146
### autogit.widget
144147
Auto Git will add a widget to the Panel by default, set this option to false to hide it.
145148

146-
![Auto Git widget](https://raw.githubusercontent.com/pedroborges/kirby-autogit/master/widget.png)
149+
![Auto Git widget](https://raw.githubusercontent.com/pedroborges/kirby-autogit/master/images/widget.png)
150+
151+
> In case a remote repository doesn't exist, the widget will only display an error message. Run `git remote add <name> <url>` to enable this feature.
147152
148153
### autogit.language
149154
Default commit language. You can choose from any of the languages that ships with Auto Git: `'en'`, `'pt_BR'` or `'pt_PT'`.
@@ -158,6 +163,7 @@ An array containing a custom translation. This will override the default transla
158163
## Roadmap
159164
- [X] Pull and push webhooks
160165
- [X] Panel widget (pull/push buttons)
166+
- [X] Trigger pull and push events
161167
- [ ] Panel widget (show commit history)
162168
- [ ] Panel widget (undo button)
163169
- [ ] Panel widget (show commit diff)

0 commit comments

Comments
 (0)