Skip to content

Commit

Permalink
Documentation improvements (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
mirland authored Oct 3, 2022
1 parent 625cd95 commit 15b4f20
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Although you can use it without a local source, the greatest benefit comes from
A [`Stock`] is responsible for managing a particular data request.

It is based on two important classes:
- [`Fetcher`]: defines how data will be fetched over network.
- [`SourceOfTruth`]: defines how local data will be read and written in your local cache. Although `Stock` can be used without it, its use is recommended.
- [`Fetcher`]: defines how data will be fetched over the network.
- [`SourceOfTruth`]: defines how local data will be read and written in your local cache. Although `Stock` can be used without it, we recommend its usage.

`Stock` uses generic keys as identifiers for data.
A key can be any value object that properly implements `toString()`, `equals()` and `hashCode()`.
Expand Down

0 comments on commit 15b4f20

Please sign in to comment.