eXparity / hamcrest-date

A Java library which provides a suite hamcrest matchers for matching dates, times, and moments in time
BSD 3-Clause "New" or "Revised" License
70 stars 11 forks source link

Improve Documentation for Getting Started/Examples #38

Closed ncovercash closed 2 years ago

ncovercash commented 2 years ago

I'm planning on making a PR to add a little more documentation to the README regarding imports and the like, just wanted to create an issue so I would not forget! I'm planning on doing this first thing next week.

I think it would help developers discovering the library have a little more context regarding the new LocalDateTime and whatnot compared to the old Date, as well as a few statements just explaining the various imports and constants (it took me quite a while to find where MINUTES was being imported from, for example -- ended up digging through the unit tests here lol)