Skip to content

Commit 68ef414

Browse files
committed
docs: update README.md
1 parent 584e949 commit 68ef414

File tree

1 file changed

+19
-34
lines changed

1 file changed

+19
-34
lines changed

README.md

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
<!-- the line below needs to be an empty line C: (its because kramdown isn't
2-
that smart and dearly wants an empty line before a heading to be able to
3-
display it as such, e.g. website) -->
4-
5-
# Design patterns implemented in Java
1+
# Design Patterns Implemented in Java
62

73
![Java CI](https://github.com/iluwatar/java-design-patterns/workflows/Java%20CI/badge.svg)
84
[![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/iluwatar/java-design-patterns/master/LICENSE.md)
@@ -20,49 +16,38 @@ Read in different language : [**zh**](localization/zh/README.md), [**ko**](local
2016

2117
# Introduction
2218

23-
Design patterns are the best, formalized practices a programmer can use to
24-
solve common problems when designing an application or system.
19+
Design patterns are the best, formalized practices a programmer can use to solve common problems when designing an application or system.
2520

26-
Design patterns can speed up the development process by providing tested, proven
27-
development paradigms.
21+
Design patterns can speed up the development process by providing tested, proven development paradigms.
2822

29-
Reusing design patterns helps prevent subtle issues that cause major
30-
problems, and it also improves code readability for coders and architects who
31-
are familiar with the patterns.
23+
Reusing design patterns helps prevent subtle issues that cause major problems, and it also improves code readability for coders and architects who are familiar with the patterns.
3224

33-
# Getting started
25+
# Getting Started
3426

35-
This site showcases Java Design Patterns. The solutions have been developed by
36-
experienced programmers and architects from the open-source community. The
37-
patterns can be browsed by their high-level descriptions or by looking at their
38-
source code. The source code examples are well commented and can be thought of as
39-
programming tutorials on how to implement a specific pattern. We use the most
40-
popular battle-proven open-source Java technologies.
27+
This site showcases Java Design Patterns. The solutions have been developed by experienced programmers and architects from the open-source community. The patterns can be browsed by their high-level descriptions or by looking at their
28+
source code. The source code examples are well commented and can be thought of as programming tutorials on how to implement a specific pattern. We use the most popular battle-proven open-source Java technologies.
4129

42-
Before you dive into the material, you should be familiar with various
43-
[Software Design Principles](https://java-design-patterns.com/principles/).
30+
Before you dive into the material, you should be familiar with various [Software Design Principles](https://java-design-patterns.com/principles/).
4431

45-
All designs should be as simple as possible. You should start with KISS, YAGNI,
46-
and Do The Simplest Thing That Could Possibly Work principles. Complexity and
47-
patterns should only be introduced when they are needed for practical
48-
extensibility.
32+
All designs should be as simple as possible. You should start with KISS, YAGNI, and Do The Simplest Thing That Could Possibly Work principles. Complexity and patterns should only be introduced when they are needed for practical extensibility.
4933

50-
Once you are familiar with these concepts you can start drilling down into the
51-
[available design patterns](https://java-design-patterns.com/patterns/) by any
52-
of the following approaches
34+
Once you are familiar with these concepts you can start drilling down into the [available design patterns](https://java-design-patterns.com/patterns/) by any of the following approaches:
5335

5436
- Search for a specific pattern by name. Can't find one? Please report a new pattern [here](https://github.com/iluwatar/java-design-patterns/issues).
5537
- Using tags such as `Performance`, `Gang of Four` or `Data access`.
5638
- Using pattern categories, `Creational`, `Behavioral`, and others.
5739

58-
Hopefully, you find the object-oriented solutions presented on this site useful
59-
in your architectures and have as much fun learning them as we had while developing them.
40+
Hopefully, you find the object-oriented solutions presented on this site useful in your architectures and have as much fun learning them as we had while developing them.
41+
42+
# How to Contribute
43+
44+
If you are willing to contribute to the project you will find the relevant information in our [developer wiki](https://github.com/iluwatar/java-design-patterns/wiki). We will help you and answer your questions in the [Gitter chatroom](https://gitter.im/iluwatar/java-design-patterns).
45+
46+
# The Book
6047

61-
# How to contribute
48+
The design patterns are now available as an e-book. Find out more about "Open Source Java Design Patterns" here: https://payhip.com/b/kcaF9
6249

63-
If you are willing to contribute to the project you will find the relevant information in
64-
our [developer wiki](https://github.com/iluwatar/java-design-patterns/wiki). We will help
65-
you and answer your questions in the [Gitter chatroom](https://gitter.im/iluwatar/java-design-patterns).
50+
The project contributors can get the book for free. Contact the maintainer via [Gitter chatroom](https://gitter.im/iluwatar/java-design-patterns) or email (iluwatar (at) gmail (dot) com ). Send a message that contains your email address, Github username, and a link to an accepted pull request.
6651

6752
# License
6853

0 commit comments

Comments
 (0)