Skip to content

Commit 09e4463

Browse files
committed
Update install instructions to use the new 3.2 way
1 parent dcd95d0 commit 09e4463

File tree

1 file changed

+16
-23
lines changed

1 file changed

+16
-23
lines changed

README.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@
33
Statamic Starter Kit: Doogie Browser
44
</h1>
55

6-
![Statamic 3.2+](https://img.shields.io/badge/Statamic-3.0+-FF269E?style=for-the-badge&link=https://statamic.com)
6+
![Statamic 3.2+](https://img.shields.io/badge/Statamic-3.2+-FF269E?style=for-the-badge&link=https://statamic.com)
7+
8+
> View on the [Statamic Marketplace](https://statamic.com/starter-kits/statamic/doogie-browser)!
79
<!-- /statamic:hide -->
10+
811
## Features
912
- Articles blogging collection with homepage listing
1013
- Markdown focused writing experience
@@ -19,50 +22,40 @@
1922
- [PurgeCSS](https://purgecss.com/) for that tiny `4kb` css file size
2023
- :100: Lighthouse score
2124

22-
<!-- statamic:hide -->
23-
## Screenshot
24-
25-
![Screenshot](/screenshot.png)
2625

27-
## Video Tour
28-
29-
Watch the [Doogie Browser video tour](https://www.youtube.com/watch?v=-cLzCWu-DeE) to see what's going on under the hood.
30-
<!-- /statamic:hide -->
3126
## Quick Start
3227

33-
**1. Create a new site** cloning the repo and removing the origin repo.
28+
### Install as a New Site
29+
You can spin up a new install of Statamic along with this Starter Kit all in one command by using the [Statamic CLI Tool](https://github.com/statamic/cli)
3430

3531
```
36-
git clone [email protected]:statamic/starter-kit-doogie-browser.git diary
37-
cd diary
38-
rm -rf .git
39-
composer install
40-
cp .env.example .env && php artisan key:generate
32+
statamic new mysite statamic/starter-kit-starters-creek
4133
```
4234

43-
**2. Make a new user** – you'll want it to be a `super` so you have access to everything.
35+
Follow the prompts and you'll be up and running shortly.
36+
37+
### Install into an existing site
38+
You can alternatively install Starter Kits into an existing Statamic 3.2+ site by running the following command while inside that install's root directory:
4439

4540
```
46-
php please make:user
41+
php please starter-kit:install statamic/starter-kit-starters-creek
4742
```
4843

49-
**3. Recompile the CSS** (optional)
5044

51-
The [TailwindCSS](https://tailwindcss.com/) included in this kit is compiled with [PurgeCSS](https://purgecss.com/) to reduce filesize on any unused classes and selectors. If you want to modify anything, just recompile it.
45+
### Customizing (optional)
46+
47+
The [TailwindCSS](https://tailwindcss.com/) included in this kit is compiled with [PurgeCSS](https://purgecss.com/) to reduce filesize on any unused classes and selectors. If you want to modify anything you'll need to recompile it.
5248

5349
```
5450
npm i && npm run dev
5551
```
5652

5753
To compile for production again:
54+
5855
```
5956
npm run production
6057
```
6158

62-
**4. Do your thing!**
63-
64-
If you're using [Laravel Valet](https://laravel.com/docs/valet) (or similar), your site should be available at `http://diary.test`. You can access the control panel at `http://diary.test/cp` and login with your new user. Open up the source code, follow along with the [Statamic 3 docs](https://statamic.dev), and enjoy!
65-
6659
## Contributing
6760

6861
Contributions are always welcome, no matter how large or small. Before contributing, please read the [code of conduct](https://github.com/statamic/cms/wiki/Code-of-Conduct).

0 commit comments

Comments
 (0)