Skip to content

Commit d557b7d

Browse files
committed
Merge branch 'statamic-5' of github.com:statamic/ssg into statamic-5
2 parents b1ff5c1 + 888ab1d commit d557b7d

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,13 @@
44
55
## Installation
66

7-
Install the package using Composer:
7+
You can install the Static Site Generator package with the following command:
88

99
```
10-
composer require statamic/ssg
10+
php please install:ssg
1111
```
1212

13-
If you want or need to customize the way the site is generated, you can do so by publishing and modifying the config file with the following command:
14-
15-
```
16-
php artisan vendor:publish --provider="Statamic\StaticSite\ServiceProvider"
17-
```
18-
19-
The config file will be in `config/statamic/ssg.php`. This is optional and you can do it anytime.
13+
The command will install the `statamic/ssg` package via Composer, optionally publish the configuration file and prompt you if you wish to install the `spatie/fork` package for running [multiple workers](#multiple-workers).
2014

2115

2216
## Usage
@@ -29,6 +23,7 @@ php please ssg:generate
2923

3024
Your site will be generated into a directory which you can deploy however you like. See [Deployment Examples](#deployment-examples) below for inspiration.
3125

26+
3227
### Multiple Workers
3328

3429
For improved performance, you may spread the page generation across multiple workers. This requires Spatie's [Fork](https://github.com/spatie/fork) package. Then you may specify how many workers are to be used. You can use as many workers as you have CPU cores.

0 commit comments

Comments
 (0)