Skip to content

Commit e22ce50

Browse files
committed
Add README.md
A README.md file has been created, providing library information and instructions for running lint, unit tests, and rector. In addition, unnecessary scripts in composer.json have been removed.
1 parent b601346 commit e22ce50

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# image-compression-lib
2+
This library is used by https://github.com/TiendaNube/tiendanube for image processing.
3+
4+
# Useful commands
5+
6+
## Run lint
7+
```
8+
docker compose -f docker-compose.cli.yml run --rm php-cs-fixer fix --verbose
9+
```
10+
11+
## Run unit tests
12+
```
13+
docker compose run --no-deps --rm php-cli composer test
14+
```
15+
16+
## Run rector
17+
```
18+
docker compose run --no-deps --rm php-rector php ../rector/vendor/bin/rector process
19+
```

composer.json

-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@
2424
}
2525
},
2626
"scripts": {
27-
"style:check": "docker-compose -f docker-compose.cli.yml run --rm php-cs-fixer fix --verbose --show-progress=estimating --dry-run",
28-
"style:fix": "docker-compose -f docker-compose.cli.yml run --rm php-cs-fixer fix --verbose --show-progress=estimating",
2927
"test": "vendor/bin/phpunit"
3028
}
3129
}

0 commit comments

Comments
 (0)