From 68ef414e1985d59576a60c466257f3e76fffa587 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ilkka=20Sepp=C3=A4l=C3=A4?= Date: Wed, 29 May 2024 11:04:16 +0300 Subject: [PATCH] docs: update README.md --- README.md | 53 +++++++++++++++++++---------------------------------- 1 file changed, 19 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index b3afe1edfb26..a2d2e676db8d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,4 @@ - - -# Design patterns implemented in Java +# Design Patterns Implemented in Java ![Java CI](https://github.com/iluwatar/java-design-patterns/workflows/Java%20CI/badge.svg) [![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 # Introduction -Design patterns are the best, formalized practices a programmer can use to -solve common problems when designing an application or system. +Design patterns are the best, formalized practices a programmer can use to solve common problems when designing an application or system. -Design patterns can speed up the development process by providing tested, proven -development paradigms. +Design patterns can speed up the development process by providing tested, proven development paradigms. -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. +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. -# Getting started +# Getting Started -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 -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. +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 +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. -Before you dive into the material, you should be familiar with various -[Software Design Principles](https://java-design-patterns.com/principles/). +Before you dive into the material, you should be familiar with various [Software Design Principles](https://java-design-patterns.com/principles/). -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. +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. -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 +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: - 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). - Using tags such as `Performance`, `Gang of Four` or `Data access`. - Using pattern categories, `Creational`, `Behavioral`, and others. -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. +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. + +# How to Contribute + +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). + +# The Book -# How to contribute +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 -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). +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. # License