Skip to content

Commit 24602f2

Browse files
committed
Improve README
1 parent b0d471d commit 24602f2

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@
66
<br>
77
</div>
88

9+
PHPTG Scaffolder is a tool for setting up project structure and configuration
10+
for PHP packages in the [PHPTG](https://github.com/phptg). It is based on
11+
[vjik/scaffolder](https://github.com/vjik/scaffolder) and automatically creates and configures essential
12+
project files including `composer.json`, GitHub Actions workflows, configuration files, and documentation structure.
13+
14+
## General Usage
15+
16+
Run the scaffolder using Docker from your project directory:
17+
18+
```bash
19+
docker run \
20+
--volume .:/project \
21+
--user $(id -u):$(id -g) \
22+
--interactive --tty --rm --init \
23+
ghcr.io/phptg/scaffolder:latest
24+
```
25+
926
## Documentation
1027

1128
If you have any questions or problems with this package, use [author telegram chat](https://t.me/predvoditelev_chat) for communication.

0 commit comments

Comments
 (0)