Skip to content

Commit 5009f51

Browse files
committed
πŸ“š Organize README.md
1 parent 12d8d15 commit 5009f51

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -24,32 +24,9 @@ Nibbles are all broken down into their own targets, so you can choose which nibb
2424

2525
## Nibbles
2626

27-
### πŸ—„οΈ Stash
28-
A simple cache that can be used to store objects.
29-
30-
Use a `Stash` to store objects of a given type in memory using an associated key.
31-
You can then fetch attempt to retrieve from the `Stash` at a later time using the key.
32-
33-
### πŸ“¬ SharedState
34-
A simple container that encapsulates an object allowing others to subscribe to and monitor changes to the state.
35-
36-
Frequently use in PointFree's TCA architecture to subscribe long-running effects to shared state changes.
37-
38-
### ⛓️ Extensions
39-
A collection of useful extensions that I freqeuntly implement across multiple projects.
40-
41-
### ⚑️ Fuse
42-
A collection of useful Combine nibbles.
43-
44-
- A variety of helpful sinks that allow for easier less verbose interactions with Combine publishers.
45-
- A variety of helpful sinks that automatically cleanup after themselves by using a `DisposableBag`.
46-
- `BuffableAsyncPublisher` and `BuffableAsyncThrowingPublisher` which both expose a `values(bufferingStrategy:)` on `Publisher`
47-
- This is a more configurable and powerful version of `values` in Combine that allows converting Combine to an async/await syntax.
48-
4927
### πŸ›œ Exchange
5028

5129
#### HTTPClient
52-
5330
An HTTP client that creates and manages requests over the network.
5431

5532
The client provides support for sharing common functionality across all requests, but each request can also layer on additional functionality if needed.
@@ -65,15 +42,38 @@ have their own nuance and complexities, and encapsulating all of that in one pla
6542
more scalable and testable way.
6643

6744
#### Socket
68-
6945
A websocket created from a URL that can listen to messages send through the connection using `AsyncStream`.
7046

7147
Sending messages and cancelling the connection is as easy as calling a few methods.
7248

73-
### 🏷️ Identified
49+
### ⛓️ Extensions
50+
A collection of useful extensions that I freqeuntly implement across multiple projects.
51+
52+
### ⚑️ Fuse
53+
A collection of useful Combine nibbles.
7454

55+
- A variety of helpful sinks that allow for easier less verbose interactions with Combine publishers.
56+
- A variety of helpful sinks that automatically cleanup after themselves by using a `DisposableBag`.
57+
- `BuffableAsyncPublisher` and `BuffableAsyncThrowingPublisher` which both expose a `values(bufferingStrategy:)` on `Publisher`
58+
- This is a more configurable and powerful version of `values` in Combine that allows converting Combine to an async/await syntax.
59+
60+
### 🏷️ Identified
7561
A protocol for marking objects as identified and allowing interaction with their identifiers in a type-safe way.
7662

63+
### πŸ“¬ SharedState
64+
A simple container that encapsulates an object allowing others to subscribe to and monitor changes to the state.
65+
66+
Frequently use in PointFree's TCA architecture to subscribe long-running effects to shared state changes.
67+
68+
### πŸ—„οΈ Stash
69+
A simple cache that can be used to store objects.
70+
71+
Use a `Stash` to store objects of a given type in memory using an associated key.
72+
You can then fetch attempt to retrieve from the `Stash` at a later time using the key.
73+
74+
### πŸ”— StateBinding
75+
A simple property wrapper that allows your views to optionally take a binding and default to internal state. Useful when creating reusable components.
76+
7777
## Contributing
7878

7979
[Learn more](https://github.com/connor-ricks/swift-nibbles/blob/main/CONTRIBUTING.md)

0 commit comments

Comments
Β (0)