Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danielbinder authored Oct 21, 2023
1 parent 38308e9 commit 9a7ff06
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Regardless of the license, it would be cool if you somehow mentioned, that you g
![lib.png](lib.png)
2) Wrap the Object you want to track in `Progresss.of("optional description", someObj)` wherever you want to consume it e.g.
- You can use it anywhere, where you would use an iterator of a Collection or an Array, since it literally returns one
- The DESCRIPTIONS are used as a key to the progress map, SO THEY NEED TO BE UNIQUE
- If you don't add a description, an incrementing counter will be added instead
- ```
for(Thing t : Progress.of(thingList)) {
Expand Down

0 comments on commit 9a7ff06

Please sign in to comment.