From 41ab86763ead26ce734cd2e337f11fea8e2af29c Mon Sep 17 00:00:00 2001 From: Narendra Pathai Date: Tue, 11 Aug 2015 11:58:02 +0530 Subject: [PATCH] Updated README for better navigational summary Links to various important sections of README is provided at the top so that it becomes easily navigable. --- README.md | 52 +++++++++++++++++++++++++++++++++++----------------- 1 file changed, 35 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 85a7aa1bf..c902cbc85 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,31 @@ # Design pattern samples in Java. -## Build status, coverage and static analysis: - ![Build status](https://travis-ci.org/iluwatar/java-design-patterns.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/iluwatar/java-design-patterns/badge.svg?branch=master)](https://coveralls.io/r/iluwatar/java-design-patterns?branch=master) Coverity Scan Build Status -## Introduction + - Introduction + - List of Design Patterns + - Creational Patterns + - Structural Patterns + - Behavioral Patterns + - Concurreny Patterns + - Presentation Tier Patterns + - Business Tier Patterns + - Architectural Patterns + - Integration Patterns + - Idioms + - Frequently Asked Questions + - How to contribute + - Contributing a new pattern + - Working on non-pattern issue + - Versioning + - Credits + - License + + +## Introduction Design patterns are formalized best practices that the programmer can use to solve common problems when designing an application or system. @@ -21,7 +39,7 @@ are familiar with the patterns. ## List of Design Patterns -### Creational Patterns +### Creational Patterns Creational design patterns abstract the instantiation process. They help make a system independent of how its objects are created, composed, and represented. @@ -36,7 +54,7 @@ system independent of how its objects are created, composed, and represented. * [Multiton](#multiton) * [Object Pool](#object-pool) -### Structural Patterns +### Structural Patterns Structural patterns are concerned with how classes and objects are composed to form larger structures. @@ -52,7 +70,7 @@ form larger structures. * [Servant](#servant) * [Event Aggregator](#event-aggregator) -### Behavioral Patterns +### Behavioral Patterns Behavioral patterns are concerned with algorithms and the assignment of responsibilities between objects. @@ -73,7 +91,7 @@ responsibilities between objects. * [Specification](#specification) * [Dependency Injection](#dependency-injection) -### Concurrency Patterns +### Concurrency Patterns Concurrency patterns are those types of design patterns that deal with the multi-threaded programming paradigm. @@ -83,7 +101,7 @@ multi-threaded programming paradigm. * [Async Method Invocation](#async-method-invocation) * [Half-Sync/Half-Async](#half-sync-half-async) -### Presentation Tier Patterns +### Presentation Tier Patterns Presentation Tier patterns are the top-most level of the application, this is concerned with translating tasks and results to something the user can @@ -94,11 +112,11 @@ understand. * [Flux](#flux) * [Front Controller](#front-controller) -### Business Tier Patterns +### Business Tier Patterns * [Business Delegate](#business-delegate) -### Architectural Patterns +### Architectural Patterns An architectural pattern is a general, reusable solution to a commonly occurring problem in software architecture within a given context. @@ -108,14 +126,14 @@ problem in software architecture within a given context. * [Naked Objects](#naked-objects) * [Repository](#repository) -### Integration Patterns +### Integration Patterns Integration patterns are concerned with how software applications communicate and exchange data. * [Tolerant Reader](#tolerant-reader) -### Idioms +### Idioms A programming idiom is a means of expressing a recurring construct in one or more programming languages. Generally speaking, a programming idiom is an @@ -891,7 +909,7 @@ degrading execution efficiency. * [Real Time CORBA](http://www.omg.org/news/meetings/workshops/presentations/realtime2001/4-3_Pyarali_thread-pool.pdf) * [Android AsyncTask framework](http://developer.android.com/reference/android/os/AsyncTask.html) -# Frequently asked questions +# Frequently asked questions **Q: What is the difference between State and Strategy patterns?** @@ -951,7 +969,7 @@ Flyweight. -# How to contribute +# How to contribute **To work on a new pattern** you need to do the following steps: @@ -989,7 +1007,7 @@ Flyweight. should be added to the corresponding section of the `README.md`. -# Versioning +# Versioning Java-design-patterns project uses [semantic versioning](http://semver.org/) scheme. However, version numbers in this project do not signify binary releases @@ -997,7 +1015,7 @@ scheme. However, version numbers in this project do not signify binary releases other words, version numbers are used only for project planning sake. -# Credits +# Credits * [Design Patterns: Elements of Reusable Object-Oriented Software](http://www.amazon.com/Design-Patterns-Elements-Reusable-Object-Oriented/dp/0201633612) * [Effective Java (2nd Edition)](http://www.amazon.com/Effective-Java-Edition-Joshua-Bloch/dp/0321356683) @@ -1020,6 +1038,6 @@ other words, version numbers are used only for project planning sake. * [Marco Castigliego - Step Builder](http://rdafbn.blogspot.co.uk/2012/07/step-builder-pattern_28.html) -# License +# License This project is licensed under the terms of the MIT license.