Skip to content

Commit 2e434d5

Browse files
committed
Update README.md with improved formatting and links.
1 parent 2ac6434 commit 2e434d5

File tree

1 file changed

+52
-32
lines changed

1 file changed

+52
-32
lines changed

README.md

Lines changed: 52 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img alt="logo" src="https://www.objectionary.com/cactus.svg" height="100px" />
1+
# Object-Oriented Java Primitives
22

33
[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
44
[![DevOps By Rultor.com](https://www.rultor.com/b/yegor256/cactoos)](https://www.rultor.com/p/yegor256/cactoos)
@@ -33,7 +33,8 @@ but mostly through static methods. Cactoos is suggesting
3333
to do almost exactly the same, but through objects.
3434

3535
**Principles**.
36-
These are the [design principles](https://www.elegantobjects.org#principles) behind Cactoos.
36+
These are the [design principles](https://www.elegantobjects.org#principles)
37+
behind Cactoos.
3738

3839
**How to use**.
3940
The library has no dependencies. All you need is this
@@ -59,12 +60,13 @@ dependencies {
5960

6061
Java version required: 1.8+.
6162

62-
StackOverflow tag is [cactoos](https://stackoverflow.com/questions/tagged/cactoos).
63+
StackOverflow tag is
64+
[cactoos](https://stackoverflow.com/questions/tagged/cactoos).
6365

6466
## Input/Output
6567

6668
More about it here:
67-
[Object-Oriented Declarative Input/Output in Cactoos](http://www.yegor256.com/2017/06/22/object-oriented-input-output-in-cactoos.html).
69+
[Object-Oriented Declarative Input/Output in Cactoos][blog].
6870

6971
To read a text file in UTF-8:
7072

@@ -119,7 +121,8 @@ new Upper(
119121

120122
## Iterables/Collections/Lists/Sets
121123

122-
More about it here: [Lazy Loading and Caching via Sticky Cactoos Primitives](http://www.yegor256.com/2017/10/17/lazy-loading-caching-sticky-cactoos.html).
124+
More about it here:
125+
[Lazy Loading and Caching via Sticky Cactoos Primitives][lazy-blog].
123126

124127
To filter a collection:
125128

@@ -299,17 +302,21 @@ new And(
299302
```
300303

301304
## Dates and Times
305+
302306
From our `org.cactoos.time` package.
303307

304-
Our classes are divided in two groups: those that parse strings into date/time objects, and those that format those objects into strings.
308+
Our classes are divided in two groups: those that parse strings into
309+
date/time objects, and those that format those objects into strings.
305310

306-
For example, this is the traditional way of parsing a string into an [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html):
311+
For example, this is the traditional way of parsing a string into an
312+
[OffsetDateTime]:
307313

308314
```java
309315
final OffsetDateTime date = OffsetDateTime.parse("2007-12-03T10:15:30+01:00");
310316
```
311317

312-
Here is its object-oriented alternative (no static method calls!) using `OffsetDateTimeOf`, which is a `Scalar`:
318+
Here is its object-oriented alternative (no static method calls!)
319+
using `OffsetDateTimeOf`, which is a `Scalar`:
313320

314321
```java
315322
final OffsetDateTime date = new OffsetDateTimeOf("2007-12-03T10:15:30+01:00").value();
@@ -322,7 +329,7 @@ final OffsetDateTime date = ...;
322329
final String text = new TextOfDateTime(date).asString();
323330
```
324331

325-
## Our objects vs. their static methods
332+
## Our Objects vs. Their Static Methods
326333

327334
Cactoos | Guava | Apache Commons | JDK 8
328335
------ | ------ | ------ | ------
@@ -351,13 +358,16 @@ Cactoos | Guava | Apache Commons | JDK 8
351358

352359
## Questions
353360

354-
Ask your questions related to cactoos library on [Stackoverflow](https://stackoverflow.com/questions/ask) with [cactoos](https://stackoverflow.com/tags/cactoos/info) tag.
361+
Ask your questions related to cactoos library on
362+
[Stackoverflow](https://stackoverflow.com/questions/ask)
363+
with the [cactoos](https://stackoverflow.com/tags/cactoos/info) tag.
355364

356365
## How to contribute?
357366

358367
Just fork the repo and send us a pull request.
359368

360369
Make sure your branch builds without any warnings/issues:
370+
361371
```bash
362372
mvn clean verify -Pqulice
363373
```
@@ -376,32 +386,42 @@ docker run \
376386
```
377387

378388
To remove the cache used by Docker-based build:
389+
379390
```bash
380391
docker volume rm cactoos-mvn-cache
381392
```
382393

383-
Note: [Checkstyle](https://en.wikipedia.org/wiki/Checkstyle) is used as a static code analysis tool with
384-
[checks list](http://checkstyle.sourceforge.net/checks.html) in GitHub precommits.
394+
Note: [Checkstyle](https://en.wikipedia.org/wiki/Checkstyle)
395+
is used as a static code analysis tool with
396+
[checks list](http://checkstyle.sourceforge.net/checks.html)
397+
in GitHub precommits.
385398

386399
## Contributors
387400

388-
- [@yegor256](https://github.com/yegor256) as Yegor Bugayenko ([Blog](http://www.yegor256.com))
389-
- [@g4s8](https://github.com/g4s8) as Kirill Che. ([email protected])
390-
- [@fabriciofx](https://github.com/fabriciofx) as Fabrício Cabral
391-
- [@englishman](https://github.com/englishman) as Andriy Kryvtsun
392-
- [@VsSekorin](https://github.com/VsSekorin) as Vseslav Sekorin
393-
- [@DronMDF](https://github.com/DronMDF) as Andrey Valyaev
394-
- [@dusan-rychnovsky](https://github.com/dusan-rychnovsky) as Dušan Rychnovský ([Blog](http://blog.dusanrychnovsky.cz/))
395-
- [@timmeey](https://github.com/timmeey) as Tim Hinkes ([Blog](https://blog.timmeey.de))
396-
- [@alex-semenyuk](https://github.com/alex-semenyuk) as Alexey Semenyuk
397-
- [@smallcreep](https://github.com/smallcreep) as Ilia Rogozhin
398-
- [@memoyil](https://github.com/memoyil) as Mehmet Yildirim
399-
- [@llorllale](https://github.com/llorllale) as George Aristy
400-
- [@driver733](https://github.com/driver733) as Mikhail Yakushin
401-
- [@izrik](https://github.com/izrik) as Richard Sartor
402-
- [@Vatavuk](https://github.com/Vatavuk) as Vedran Grgo Vatavuk
403-
- [@dgroup](https://github.com/dgroup) as Yurii Dubinka
404-
- [@iakunin](https://github.com/iakunin) as Maksim Iakunin
405-
- [@fanifieiev](https://github.com/fanifieiev) as Fevzi Anifieiev
406-
- [@victornoel](https://github.com/victornoel) as Victor Noël
407-
- [@paulodamaso](https://github.com/paulodamaso) as Paulo Lobo
401+
* [@yegor256](https://github.com/yegor256)
402+
as Yegor Bugayenko ([Blog](http://www.yegor256.com))
403+
* [@g4s8](https://github.com/g4s8) as Kirill Che. ([email protected])
404+
* [@fabriciofx](https://github.com/fabriciofx) as Fabrício Cabral
405+
* [@englishman](https://github.com/englishman) as Andriy Kryvtsun
406+
* [@VsSekorin](https://github.com/VsSekorin) as Vseslav Sekorin
407+
* [@DronMDF](https://github.com/DronMDF) as Andrey Valyaev
408+
* [@dusan-rychnovsky](https://github.com/dusan-rychnovsky)
409+
as Dušan Rychnovský ([Blog](http://blog.dusanrychnovsky.cz/))
410+
* [@timmeey](https://github.com/timmeey)
411+
as Tim Hinkes ([Blog](https://blog.timmeey.de))
412+
* [@alex-semenyuk](https://github.com/alex-semenyuk) as Alexey Semenyuk
413+
* [@smallcreep](https://github.com/smallcreep) as Ilia Rogozhin
414+
* [@memoyil](https://github.com/memoyil) as Mehmet Yildirim
415+
* [@llorllale](https://github.com/llorllale) as George Aristy
416+
* [@driver733](https://github.com/driver733) as Mikhail Yakushin
417+
* [@izrik](https://github.com/izrik) as Richard Sartor
418+
* [@Vatavuk](https://github.com/Vatavuk) as Vedran Grgo Vatavuk
419+
* [@dgroup](https://github.com/dgroup) as Yurii Dubinka
420+
* [@iakunin](https://github.com/iakunin) as Maksim Iakunin
421+
* [@fanifieiev](https://github.com/fanifieiev) as Fevzi Anifieiev
422+
* [@victornoel](https://github.com/victornoel) as Victor Noël
423+
* [@paulodamaso](https://github.com/paulodamaso) as Paulo Lobo
424+
425+
[blog]: http://www.yegor256.com/2017/06/22/object-oriented-input-output-in-cactoos.html
426+
[OffsetDateTime]: https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html
427+
[lazy-blog]: http://www.yegor256.com/2017/10/17/lazy-loading-caching-sticky-cactoos.html

0 commit comments

Comments
 (0)