Skip to content
This repository has been archived by the owner on Jan 25, 2021. It is now read-only.

Commit

Permalink
Update readme with instructions for the new plugin commands
Browse files Browse the repository at this point in the history
  • Loading branch information
bastianallgeier committed Mar 1, 2016
1 parent 8c10458 commit b5a8427
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,42 @@ kirby update --nightly

****

### kirby plugin:install

You can install Kirby plugins with a valid package.json file and plugin type field from any repo on Github.

```
kirby plugin:install getkirby-plugins/cachebuster-plugin
```

You must pass the correct Github repository path as the second argument. The package.json file has to contain a `type` field with one of the following values:

- kirby-plugin (will be installed in /site/plugins)
- kirby-field (will be installed in /site/fields)
- kirby-tag (will be installed in /site/tags)

If you want to install a plugin from Kirby's official Plugins organisation (<https://github.com/getkirby-plugins>) you can omit the full path and just specify the repo name:

```
kirby plugin:install cachebuster-plugin
```

### kirby plugin:update

To update an existing plugin, you can use…

```
kirby plugin:update getkirby-plugins/cachebuster-plugin
```

The shortcut for official plugins is working here as well:

```
kirby plugin:update cachebuster-plugin
```

****

### kirby make:blueprint

To create a boilerplate blueprint for a particular template, you can use the kirby make:blueprint command:
Expand Down

0 comments on commit b5a8427

Please sign in to comment.