Skip to content

Commit ca0ee68

Browse files
authored
[#70] Updated README.md
1 parent 9fd1f21 commit ca0ee68

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,22 @@
33
[![Build Status](https://img.shields.io/travis/project-avral/oo-atom/master.svg)](https://travis-ci.org/project-avral/oo-atom)
44
[![PDD status](http://www.0pdd.com/svg?name=project-avral/oo-atom)](http://www.0pdd.com/p?name=project-avral/oo-atom)
55

6-
OO-atom is a desperate attempt to make Java programming more predictable and transparent. Instead of fighting the boilerplate code by hiding it, introducing hidden coupling, like it is done by Java EE, Spring and Hibernate, OO-atom greets clean design by taking the most from Java SE, and the best from OOP.
6+
## Disclaimer
7+
The project is currently on early stage. Not all of the planned features are currently implemented, and everything may be changed in future.
8+
9+
## Intro
10+
11+
OO-atom is a desperate attempt to make Java programming more predictable and transparent. Instead of fighting the boilerplate code by hiding it, introducing hidden coupling, like it is done by Java EE, Spring, Hibernate and other "magical" solutions, OO-atom greets clean and open design by taking the most from Java SE, and the best from OOP.
12+
13+
The project is inspired by the guidelines from the books "[Elegant Objects](http://www.yegor256.com/elegant-objects.html)", written by Yegor Bugayenko, and the materials from his [blog](http://www.yegor256.com/tag/oop.html). However, several changes and additions were made to initial concept - see [this]() page for the list of differences.
714

8-
The project is built around the term named Atom. Atom is a Java class, which strictly follows a set of [requirements](ATOM_SPECIFICATION.md). For each Atom, OO-atom project enforces:
9-
- composition over inheritance
10-
- design by contract
11-
- safe code reuse techniques
12-
- SOLID
15+
The project is built around the term named Atom. Atom is a Java class, which strictly follows a set of [requirements](ATOM_SPECIFICATION.md). For all Atoms, OO-atom seeks for the best ways of improving quality, maintainability, test coverage and performance.
1316

1417
OO-atom project is designed on the following principles:
1518
- it is transparent. It never dictates the architecture of your applications.
1619
- it is flexible. You are free to use it with any solution from a large Java ecosystem
1720
- it operates at compile-time only. It never brings ad-hoc runtime dependencies to your application.
1821

19-
The project is inspired by the guidelines from the books "[Elegant Objects](http://www.yegor256.com/elegant-objects.html)", written by Yegor Bugayenko, and the materials from his [blog](http://www.yegor256.com/tag/oop.html). However, several changes and additions were made to initial concept - see [this]() page for the list of differences.
20-
2122
# Quick start with Maven
2223

2324
1. Add OO-atom repository to your project's POM file:
@@ -61,7 +62,5 @@ The project is inspired by the guidelines from the books "[Elegant Objects](http
6162

6263
4. Study the [samples](atom-samples)
6364

64-
Maven will track each class of your project, fail the project's build if any of the class doesn't match the Atom's specification, and apply additional instrumentaions for each Atom. This process is the recommended way of development in OO-atom-managed projects, but in complicated cases, it can be overriden. This process in details is explained [here]().
6565

66-
## Disclaimer
67-
The project is currently on early stage. Not all of the features are currently implemented, and everything may be changed in future.
66+

0 commit comments

Comments
 (0)