Skip to content

Commit

Permalink
Publish test (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
shalanah committed Feb 11, 2024
1 parent 7b80c58 commit 960c4dd
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 21 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# inapp-spy

## 1.0.7

### Patch Changes

- e775e7d: Test out publishing workflow

## 1.0.6

### Patch Changes
Expand Down
50 changes: 30 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# InApp Spy 🔎

Detect in-app browsers

<!-- TODO: BADGING -->
Detect in-app browsers - fork of `detect-inapp` with API modifications + additions

# Installation

Expand All @@ -18,33 +16,45 @@ const { isInApp, appName } = InAppSpy();

# API Reference

```js
InAppSpy(options: { ua?: string } | undefined)
```
## Return properties

### Parameters (optional)
### isInApp

```js
{
ua?: string;
}
```
Detected in-app browser

### Return properties
`boolean`

#### `isInApp`
### appName

`boolean` - Whether the user is in an in-app browser
Recognized app name with in-app browser

#### `appName`
```ts
"messenger" |
"facebook" |
"twitter" |
"wechat" |
"instagram" |
"tiktok" |
"snapchat" |
"line" |
undefined;
```

Can be `undefined` if `isInApp: true`.

Values: "messenger", "facebook", "twitter", "wechat", "instagram", "tiktok", "snapchat", "line", or `undefined`
### ua

Can be undefined even when `isInApp` is true.
The user agent passed in or figured out by `InAppSpy()` function

#### `ua`
`string`

`string` - The user agent passed in or figured out by `InAppSpy()` function
## Parameters (optional)

```ts
{
ua?: string;
}
```

# License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "inapp-spy",
"version": "1.0.6",
"version": "1.0.7",
"description": "detect in-app browsers",
"author": "Shalanah Dawson",
"homepage": "https://github.com/shalanah/inapp-spy",
Expand Down

0 comments on commit 960c4dd

Please sign in to comment.