mirror of
https://github.com/silverstripe/recipe-plugin.git
synced 2024-10-22 14:05:55 +02:00
Use GFM for code
This commit is contained in:
parent
a4a1e00a73
commit
c247a87dfa
23
README.md
23
README.md
@ -24,30 +24,27 @@ These recipes allow for the following features:
|
||||
|
||||
Recipes can be introduced to any existing project (even if not created on a silverstripe base project)
|
||||
|
||||
|
||||
:::shell
|
||||
```shell
|
||||
$ composer init
|
||||
$ composer require silverstripe/recipe-plugin ^0.1
|
||||
$ composer require-recipe silverstripe/recipe-cms ^4.0@dev
|
||||
|
||||
````
|
||||
|
||||
Alternatively, instead of having to install the recipe-plugin manually, you can require the recipe
|
||||
directly and inline this as a subsequent command. This is necessary to make the new commands available
|
||||
to the command line.
|
||||
|
||||
|
||||
:::shell
|
||||
```shell
|
||||
$ composer init
|
||||
$ composer require silverstripe/recipe-cms ^4.0@dev
|
||||
$ composer upgrade-recipe silverstripe/recipe-cms
|
||||
|
||||
```
|
||||
|
||||
Alternatively you can create a new project based on an existing recipe
|
||||
|
||||
|
||||
:::shell
|
||||
```shell
|
||||
$ composer create-project silverstripe/recipe-cms ./myssproject ^4.0@dev
|
||||
|
||||
```
|
||||
|
||||
## Upgrading recipes
|
||||
|
||||
@ -57,10 +54,9 @@ via `composer upgrade-recipe`.
|
||||
When upgrading a version constraint is recommended, but not necessary. If omitted, then the existing installed
|
||||
version will be detected, and a safe default chosen.
|
||||
|
||||
|
||||
:::shell
|
||||
```shell
|
||||
$ composer upgrade-recipe silverstripe/recipe-cms ^1.0@dev
|
||||
|
||||
```
|
||||
|
||||
## Installing or upgrading recipes without inlining them
|
||||
|
||||
@ -87,7 +83,7 @@ Recipe types should follow the following rules:
|
||||
|
||||
An example recipe:
|
||||
|
||||
:::json
|
||||
```json
|
||||
{
|
||||
"name": "silverstripe/example-recipe,
|
||||
"description": "Example silverstripe recipe",
|
||||
@ -106,3 +102,4 @@ An example recipe:
|
||||
"prefer-stable": true,
|
||||
"minimum-stability": "dev"
|
||||
}
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user