Skip to content

Commit

Permalink
chore(readme): update readme to reflect package rename, add note abou…
Browse files Browse the repository at this point in the history
…t fin rc and composer command
  • Loading branch information
Jude Reid committed Nov 5, 2020
1 parent da254d7 commit 8c3e891
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,11 @@ In order to use the docksal configuration in this starter, you'll need to have D

1. Create a new project via composer, replacing 'myproject' with the desired project directory name
```sh
fin rc composer create-project batch/craft-starter myproject --remove-vcs
fin rc composer create-project batch/craft myproject --remove-vcs
```
**Note:** We recommend using Docksal's [fin rc](https://docs.docksal.io/fin/fin-help/#run-cli) and [fin exec](https://docs.docksal.io/fin/fin-help/#exec) commands, which will execute the commands on a standalone 'cli' container mapped to the current directory. This ensures the commands will run even if Composer or NPM are not installed locally.

The `--remove-vcs` flag will removes the batch/craft git metadata so this will be ready for use in a project repository.
2. Update the docksal configuration

Edit `.docksal/docksal.env` and set the Virtual Host domains to match the local host name you want to use eg. craftstarter.batch
Expand Down

0 comments on commit 8c3e891

Please sign in to comment.