Skip to content

Commit b5449b8

Browse files
committed
Update README.md
1 parent 6894ede commit b5449b8

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ The main branch is just a template for every other branch.
1010
Also, to make it easier to download the source code, [releases](https://github.com/LBeghini/Java-Design-Patterns/releases) are created related to the task of the week, giving a snapshot of the code for that specific implementation.
1111

1212
## Implemented design patterns
13+
1314
### Behavioural patterns
15+
1416
- [ ] Chain of responsability
1517
- [ ] Command
1618
- [ ] Iterator
@@ -21,13 +23,15 @@ Also, to make it easier to download the source code, [releases](https://github.c
2123
- [ ] Template method
2224

2325
### Creational patterns
26+
2427
- [ ] Abstract factory
2528
- [x] [Builder](https://github.com/LBeghini/Java-Design-Patterns/releases/tag/1.builder)
2629
- [ ] Factory method
2730
- [ ] Prototype
2831
- [x] [Singleton](https://github.com/LBeghini/Java-Design-Patterns/releases/tag/1.singleton)
2932

3033
### Structural patterns
34+
3135
- [ ] Adapter
3236
- [ ] Bridge
3337
- [ ] Composite
@@ -38,39 +42,49 @@ Also, to make it easier to download the source code, [releases](https://github.c
3842
- [ ] Proxy
3943

4044
## Technologies
45+
4146
- Java
4247
- JUnit
4348
- Maven
4449

4550
## Requirements
51+
4652
To run and edit the project, be sure to have installed in your computer the following softwares:
4753
- A code editor
4854

4955
After that, you'll need to clone this repo:
50-
```
56+
57+
```bash
5158
git clone https://github.com/LBeghini/Java-Design-Patterns.git
5259
```
5360

5461
## Change branch
62+
5563
To change to a different branch, run the command:
64+
5665
```bash
5766
git checkout name-of-the-branch
5867
```
68+
5969
The branch names have the pattern:
6070

61-
```
71+
```bash
6272
{number-of-the-week}-{pattern-name}
6373
```
74+
6475
> `number-of-the-week` corresponds to the week asked to be implemented certain pattern
6576
6677
## Testing
78+
6779
This project has no aim to run any of the implemented classes, as the goal is the code itself. However, the classes will be tested to visualize the behaviour and implementation
6880
of the patterns.
6981

7082
You can run the tests using the maven wrapper:
83+
7184
```bash
7285
./mvnw test
7386
```
7487

7588
## :balance_scale: License
89+
7690
[MIT License](https://github.com/LBeghini/Java-Design-Patterns/blob/main/LICENSE)

0 commit comments

Comments
 (0)