Skip to content

Commit

Permalink
Clean up docs to reflect sentry change
Browse files Browse the repository at this point in the history
  • Loading branch information
dcramer committed Nov 22, 2023
1 parent 472db3a commit a739920
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 29 deletions.
20 changes: 0 additions & 20 deletions packages/core/README.md

This file was deleted.

24 changes: 15 additions & 9 deletions packages/website/src/content/docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,27 @@ title: Configuration
description: All the configuration options for setting up Spotlight
---

## Configure `spotlight`
## `init`

```js
import * as Spotlight from '@spotlightjs/core';
import {init, sentry} as Spotlight from '@spotlightjs/core';

Spotlight.init({
integrations: [Spotlight.sentry()],
init({
integrations: [sentry()],
});
```

### `integrations`

**type:** [`SpotlightIntegration[]`](#spotlightintegration)

Defines which integrations should be loaded for Spotlight.
Defines which integrations should be loaded for Spotlight. Defaults to `[sentry()]`.

```ts
init({
integrations: [sentry()],
});
```

#### `SpotlightIntegration`

Expand All @@ -32,8 +38,8 @@ type SpotlightIntegration = {};

The Sidecar event-source stream endpoint.

```js
Spotlight.init({
```ts
init({
sidecar: 'http://localhost:8969/stream',
});
```
Expand All @@ -44,8 +50,8 @@ Spotlight.init({

The anchor position for the toolbar.

```js
Spotlight.init({
```ts
init({
anchor: 'centerRight',
});
```
Expand Down

0 comments on commit a739920

Please sign in to comment.