Skip to content

Commit e251fab

Browse files
committed
docs: update README with badge and clarify project generation instructions
1 parent 273de4f commit e251fab

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# template project for hexagonal-spring-boot-kotlin
1+
# template project for hexagonal-spring-boot-kotlin [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
22

33

4-
This is a template project for hexagonal-spring-boot-java. This project is generated using [copier](https://copier.readthedocs.io/en/stable/) [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier).
4+
This is a template project for hexagonal-spring-boot-java. This project is generated using [copier](https://copier.readthedocs.io/en/stable/) .
55

66
## Pre-requisites
77

@@ -39,10 +39,26 @@ Following are the keywords reserved for the template project and their equivalen
3939
| EXAMPLES | {{domain_plural_uppercase}} |
4040
| EXAMPLE | {{domain_uppercase}} |
4141

42-
Refer script [generate-copier-template-from-example-project.sh](generate-copier-template-from-example-project.sh) which is used to generate the copier template project. This script is also being used by [`.github/workflows/ci.yaml`](.github/workflows/ci.yaml) pipeline too.
42+
Refer script [generate-copier-template-from-example-project.sh](generate-copier-template-from-example-project.sh) which is used to generate the copier template project. This script is also being used by [generate-template.yaml](.github/workflows/generate-template.yaml) pipeline too.
4343

4444
### {{app_name}}
4545

46-
> NOTE: DO NOT MODIFY THIS DIRECTORY DIRECTLY
46+
> [!WARNING]
47+
> DO NOT MODIFY THIS DIRECTORY DIRECTLY
4748
4849
This directory contains the generated project from `example` project. The project is generated using the script [generate-cookiecutter-template-from-example-project.sh](generate-copier-template-from-example-project.sh) which is used to generate the copier template project.
50+
51+
52+
## Generating a new project
53+
54+
The following command can be used to generate a new project using this template:
55+
56+
```bash
57+
copier copy . <destination_folder>
58+
```
59+
60+
Command to generate with default values without prompt:
61+
62+
```bash
63+
copier copy . . --defaults
64+
```

0 commit comments

Comments
 (0)