From 9852e0b75fed3fd8c1d85bdc4d452f132009f169 Mon Sep 17 00:00:00 2001 From: Alex Skrypnyk Date: Sat, 9 Sep 2023 16:18:15 +1000 Subject: [PATCH] Added init screen. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24c5919..99b2d72 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [![Scaffold test](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/scaffold-test.yml/badge.svg)](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/scaffold-test.yml) ![LICENSE](https://img.shields.io/github/license/AlexSkrypnyk/scaffold) | | **Features**

- **PHP**
    - `composer.json` config
    - Symfony CLI command app scaffold with unit tests (with coverage) and traits
    - Simple single-file script scaffold with unit tests (with coverage) and traits
    - Code quality tools with configurations: PHP Code Sniffer, PHP Mess Detector, PHP Stan
- **NodeJS**
    - `package.json` config
- **CI**
    - Lint, test and publish PHP as PHAR
    - Build and test for NodeJS
    - Release drafter
    - Release asset packaging and upload
    - PR auto-assign
    - Funding
- **Utility files**
    - Readme with badges
    - `.editorconfig`, `.gitignore`, `.gitattributes`
    - Init shell script to chose features | -| **How to use this scaffold repository**

1. Click on **Use this template** > **Create a new repository**
2. Checkout locally
3. Run `./init.sh` to replace `yournamespace`, `yourproject`, `Your Name` strings with your own and choose the features. | +| **How to use this scaffold repository**

1. Click on **Use this template** > **Create a new repository**
2. Checkout locally
3. Run `./init.sh` to replace `yournamespace`, `yourproject`, `Your Name` strings with your own and choose the features.
![init](https://github.com/AlexSkrypnyk/scaffold/assets/378794/43962d9f-eae7-4b54-bec8-2e3139ed722c) | | This table will be removed after running `./init.sh`. | The contents below will be a part of your repository. |