Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kean committed Sep 15, 2024
1 parent 82f36e0 commit 855411e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
4 changes: 4 additions & 0 deletions Sources/Pulse/Pulse.docc/Articles/NextSteps.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Learn how to configure Pulse to best suit your app needs.

## Console

Pulse is highly customizable and you can tweak it to best match your style and your backend. To learn more, see [PulseUI: Overview](https://kean-docs.github.io/pulseui/documentation/pulseui/).

## Logger

### Configure Store
Expand Down
12 changes: 10 additions & 2 deletions Sources/PulseUI/PulseUI.docc/PulseUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ A set of components that you can integrate into your app to view the logs.

## Overview

### SwiftUI

The easiest way to integrate PulseUI is by using ``ConsoleView``.

```swift
Expand All @@ -24,7 +26,7 @@ NavigationLink(destination: ConsoleView()) {

> tip: If you use Pulse to log only network requests, and not text messages, use `ConsoleView(mode: .network)` to show a view specialized to only display network requests.
## UIKit
### UIKit

To present the console from `UIKit`, use `UIHostingController`:

Expand All @@ -45,7 +47,13 @@ nav.navigationBar.prefersLargeTitles = true
present(nav, animated: true)
```

## Custom Views
## Customization

### Settings

Pulse is highly customizable and provides a massive number of settings in ``UserSettings``, including the options for customizing the look of the cells in the list, and more.

### Custom Views

PulseUI gives you complete access to the underlying data and its model. You can easily create custom views into your log data by using affordances provided by SwiftUI:

Expand Down

0 comments on commit 855411e

Please sign in to comment.