From b5f089c28eaa787eadc4ecbf925c95ecdbf7e490 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samuel=20=C5=A0tancl?= Date: Sun, 23 May 2021 13:23:38 +0200 Subject: [PATCH] Update README.md --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d7bf5b4..1c0bfcc 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,17 @@ Simple and flexible package template. # Usage - Replace all occurances of `REPLACE` (case sensitive) with the name of the package namespace. E.g. the `Foo` in `ArchTech\Foo`. -- Replace all occurances of `replace2` with the name of the package on composer, e.g. the `bar` in `archtechx/bar`. -- If MySQL is not needed, remove `docker-compose.yml`, remove the line that runs docker from `./check`, and set `DB_CONNECTION` in `phpunit.xml` to `sqlite`, and `DB_DATABASE` to `:memory:`. + - Also do this for file names, e.g. `REPLACEServiceProvider.php`. +- Replace all occurances of `replace` with the name of the package on composer, e.g. the `bar` in `archtechx/bar`. +- If MySQL is not needed, remove `docker-compose.yml`, remove the line that runs docker from `./check`, and remove it from the `.github/ci.yml` file. + - If SQLite is wanted, change `DB_CONNECTION` in `phpunit.xml` to `sqlite`, and `DB_DATABASE` to `:memory:`. --- ## Installation ```sh -composer require stancl/replace2 +composer require archtechx/replace ``` ## Usage @@ -30,12 +32,4 @@ Running all checks locally: ./check ``` -Running tests: - -```sh -MYSQL_PORT=3307 docker-compose up -d - -phpunit -``` - Code style will be automatically fixed by php-cs-fixer.