chor: Fill readme and update config.publish command

Author: MasterRO94

README.md

@@ -1 +1,68 @@
-# dockerize-php-code-analysis
+# Dockerized PHP Code Analysis Tool
+
+This dockerized tool provides you Makefile commands to check and fix PHP code.  
+It's built on top of https://github.com/easy-coding-standard/easy-coding-standard library 
+and uses some other supported packages to cover as many rules as possible.
+
+## Installation
+1. Download [code.mk](./bin/code.mk)
+2. Include `code.mk` in your `Makefile`  
+```makefile
+include code.mk
+```
+3. Use :)
+
+## Usage
+This tool uses `code.` namespace for all the commands it provides.  
+Use `make help` if available in your project to see for available commands.  
+You can see details in `code.mk` file to be aware of all available commands.
+
+#### Check code
+```shell
+make code.check
+```
+
+```shell
+make code.check path=src/app/Http
+```
+
+```shell
+make code.check.dirty
+```
+
+```shell
+make code.check.diff
+```
+
+```shell
+make code.check.diff branch=main
+```
+
+#### Fix code
+```shell
+make code.fix
+```
+
+```shell
+make code.fix path=src/app/Http
+```
+
+```shell
+make code.fix.dirty
+```
+
+```shell
+make code.fix.diff
+```
+
+```shell
+make code.fix.diff branch=main
+```
+
+#### Configure checker
+
+1. Publish the config
+```shell
+make code.config.publish
+```
+2. Modify `ecs.php` file to fit your needs.

bin/code.mk

@@ -3,8 +3,8 @@
 version ?= 0.2.0
 branch ?= develop
 
-#ECS_IMAGE := hub.jcdev.net:24000/php-code-analysis-tool:${version}
-ECS_IMAGE := docker.io/library/dockerize-php-code-analysis-php-code-analysis-tool
+ECS_IMAGE := hub.jcdev.net:24000/php-code-analysis-tool:${version}
+#ECS_IMAGE := docker.io/library/dockerize-php-code-analysis-php-code-analysis-tool
 
 # Define default path if one is not passed
 ifndef path
@@ -73,7 +73,7 @@ code.fix.diff:
 ##
 code.config.publish:
 	@echo '...........Publishing config'
-	@$(eval CONTAINER_ID = $(shell docker create hub.jcdev.net:24000/php-code-analysis-tool:latest))
+	@$(eval CONTAINER_ID = $(shell docker create ${ECS_IMAGE}))
 	@docker cp ${CONTAINER_ID}:/app/ecs.php ecs.php
 	@docker rm -v ${CONTAINER_ID}
 	@echo '...........Published "ecs.php"'