Skip to content
This repository was archived by the owner on Aug 30, 2022. It is now read-only.

Commit ff5f4fb

Browse files
authored
Add packages section to README (#21)
1 parent 3fb43b4 commit ff5f4fb

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,18 @@ dependencies {
193193
}
194194
```
195195

196+
## Packages
197+
198+
**Able** provides a number of packages to help extend it's functionality:
199+
200+
| Package | Functionality |
201+
|-------------------|-----------------------------------------------------------------------------------------------------------------|
202+
| [`processor`] | A `Processor` adds the ability to process (and optionally modify) GATT data<br/>pre-write or post-read. |
203+
| [`retry`] | `Retry` wraps a `Gatt` to add I/O retry functionality and on-demand connection<br/>establishment. |
204+
| [`throw`] | Adds extension functions that `throw` exceptions on failures for various BLE<br/>operations. |
205+
| [`timber-logger`] | Routes **Able** logging through [Timber](https://github.com/JakeWharton/timber). |
206+
| [`device`] | Provides `BluetoothDevice` extension functions as a single access point for<br/>connectivity and communication. |
207+
196208
# License
197209

198210
```
@@ -223,3 +235,8 @@ limitations under the License.
223235
[bluetooth permissions]: https://developer.android.com/guide/topics/connectivity/bluetooth#Permissions
224236
[structured concurrency]: https://medium.com/@elizarov/structured-concurrency-722d765aa952
225237
[`CoroutineScope`]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.experimental/-coroutine-scope/
238+
[`processor`]: processor
239+
[`retry`]: retry
240+
[`throw`]: throw
241+
[`timber-logger`]: timber-logger
242+
[`device`]: device

0 commit comments

Comments
 (0)