diff --git a/.github/workflows/code-standart.yml b/.github/workflows/code-standart.yml index e0eea57..ce5bd95 100644 --- a/.github/workflows/code-standart.yml +++ b/.github/workflows/code-standart.yml @@ -1,4 +1,4 @@ -name: DEPLOY AND BUILD +name: CODE CHECK - TESTS on: ['push', 'pull_request'] @@ -35,4 +35,4 @@ jobs: run: composer cs-check - name: Run tests - run: composer tests \ No newline at end of file + run: composer tests diff --git a/README.md b/README.md index 1f1ceb5..51fa0fc 100755 --- a/README.md +++ b/README.md @@ -2,6 +2,46 @@ This repository is designed to give you a template with which you can create your own packages. +GitHub Workflow Status +Total Downloads +Latest Version +License + +## Installation + +To start the template you will need git and docker/docker compose + +**Performing steps:** + +You can also submit a template to yourself through the GitHub interface ↙️ +```bash +git clone https://github.com/deniskorbakov/skeleton-php-docker +``` + +Let's go to the cloned repository ⛳ +```bash +cd skeleton-php-docker +``` + +To start, initialize the project and use it 🔥 +```bash +make init +``` + +## What do you get + +* Ready-made template project using the latest version of PHP +* Tests using pest +* Static analyzers: phpstan/rector/phpcs +* Ready-made environment using docker + + +I would be glad to receive your **feedback** + +[@Denis Korbakov](https://github.com/deniskorbakov) + +This repository is designed to give you a template with which you can create your own packages. + ## Installation To start the template you will need git and docker/docker compose