archtechx/template
1
0
Fork 0
mirror of https://github.com/archtechx/template.git synced 2025-12-12 05:14:04 +00:00
Code Activity

Update README.md

Browse source
This commit is contained in:
Samuel Štancl 2021-05-23 13:23:38 +02:00 • committed by GitHub
parent 7ffed3484b
commit b5f089c28e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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.