Skip to content

Commit

Permalink
Gramatical and Punctuation Fixes
Browse files Browse the repository at this point in the history
This fixes some gramatical and punctuation fixes.
  • Loading branch information
anthonycastelli committed Apr 24, 2024
1 parent 808611c commit 7b8d039
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 32 deletions.
10 changes: 5 additions & 5 deletions docs/browser/web-apps/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ The JavaScript SDK allows you to drop-in analytic tracking, direct to your AppFi
Install the SDK using NPM or Yarn.

=== "NPM"
```shell
`shell
npm install @uptechworks/appfit-browser-sdk
```
`

=== "Yarn"
```shell
`shell
yarn add @uptechworks/appfit-browser-sdk
```
`

---

The AppFit SDK is Open Source. Find it on [GitHub here](https://github.com/uptech/appfit-javascript-sdk)
The AppFit SDK is open source. Find it on [GitHub here](https://github.com/uptech/appfit-javascript-sdk).
12 changes: 6 additions & 6 deletions docs/browser/web-apps/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ import {
const config = new AppFitBrowserConfiguration("API_KEY");

// Create the AppFit Client
const appFitClient = new AppFit(config);
const appFit = new AppFit(config);

// Use the client to track events
await appFitClient.trackEvent("event_name", { example: "property" });
await appFit.trackEvent("event_name", { example: "property" });
```

## Identifying Users
Expand All @@ -42,15 +42,15 @@ The AppFit SDK includes an identify call that you can use to identify users in y
This method supports any String-based identifier.

```javascript
appFitClient.identifyUser("USER_ID");
appFit.identifyUser("USER_ID");
```

Leaving out the user ID will remove all future events from including the id.
Setting this identifier to null will remove user tracking from all events going forward.

```javascript
appFitClient.identifyUser();
appFit.identifyUser();
```

## Cached Events

We cache all events locally in the SDK. This allows us to retry failed events. If a device is experiencing network issues, we will retry the saved events later to help avoid losing any metrics.
We cache all event locally in the SDK, allowing us to retry failed events. If a device is experiencing network issues, we will retry events once the device is back online to help avoid event data loss.
2 changes: 1 addition & 1 deletion docs/browser/web-pages/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ Once the full AppFit code is loaded, it is available to other `<script>` tags. I

---

The AppFit SDK is Open Source. Find it on [GitHub here](https://github.com/uptech/appfit-javascript-sdk)
The AppFit SDK is open source. Find it on [GitHub here](https://github.com/uptech/appfit-javascript-sdk).
2 changes: 1 addition & 1 deletion docs/flutter/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ appfit:
---
The AppFit SDK is Open Source. Find it on [GitHub here](https://github.com/uptech/appfit-flutter-sdk)
The AppFit SDK is open source. Find it on [GitHub here](https://github.com/uptech/appfit-flutter-sdk).
8 changes: 4 additions & 4 deletions docs/flutter/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ final configuration = AppFitConfiguration(apiKey: 'API_KEY');
final appFit = AppFit(configuration: configuration);
```

Once you have the client constructed, tracking an event is as simple as calling `trackEvent`
Once you have the client constructed, tracking an event is as simple as calling `trackEvent`.

A full example can be found below.

Expand All @@ -34,15 +34,15 @@ The AppFit SDK includes an `identify` call, that you can use to identify users i
This method supports any String-based identifier.

```dart
appfit.identifyUser("<id>");
appfit.identifyUser("USER_ID");
```

Setting this to null, will remove all events going forward from including the userId.
Setting this identifier to null will remove user tracking from all events going forward.

```dart
appfit.identifyUser(null);
```

# Cached Events

We cache all events locally in the SDK. This allows us to rety failed events. If a device is experiencing network issues, we will retry the saved events later to help avoid losing any metrics.
We cache all event locally in the SDK, allowing us to retry failed events. If a device is experiencing network issues, we will retry events once the device is back online to help avoid event data loss.
2 changes: 1 addition & 1 deletion docs/kotlin/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Once you have your gradle file configures, dont forget to enable internet access

---

The AppFit SDK is Open Source. Find it on [GitHub here](https://github.com/uptech/appfit-kotlin-sdk)
The AppFit SDK is open source. Find it on [GitHub here](https://github.com/uptech/appfit-kotlin-sdk).
6 changes: 3 additions & 3 deletions docs/kotlin/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Your API Key can be obtained from your AppFit Dashboard.
val appFit = AppFit(configuration = configuration)
```

Once you have the client constructed, tracking an event is as simple as calling `trackEvent`
Once you have the client constructed, tracking an event is as simple as calling `trackEvent`.

A full example can be found below.

Expand All @@ -34,12 +34,12 @@ This method supports any String-based identifier.
appfit.identifyUser("USER_ID")
```

Setting this to null, will remove all events going forward from including the userId.
Setting this identifier to null will remove user tracking from all events going forward.

```kotlin
appfit.identifyUser(null)
```

# Cached Events

We cache all events locally in the SDK. This allows us to rety failed events. If a device is experiencing network issues, we will retry the saved events later to help avoid losing any metrics.
We cache all event locally in the SDK, allowing us to retry failed events. If a device is experiencing network issues, we will retry events once the device is back online to help avoid event data loss.
10 changes: 5 additions & 5 deletions docs/node/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ The JavaScript SDK allows you to drop-in analytic tracking, direct to your AppFi
Install the SDK using NPM or Yarn.

=== "NPM"
```shell
`shell
npm install @uptechworks/appfit-browser-sdk
```
`

=== "Yarn"
```shell
`shell
yarn add @uptechworks/appfit-browser-sdk
```
`

---

The AppFit SDK is Open Source. Find it on [GitHub here](https://github.com/uptech/appfit-javascript-sdk)
The AppFit SDK is open source. Find it on [GitHub here](https://github.com/uptech/appfit-javascript-sdk).
2 changes: 1 addition & 1 deletion docs/swift/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ dependencies: [

---

The AppFit SDK is Open Source. Find it on [GitHub here](https://github.com/uptech/appfit-swift-sdk)
The AppFit SDK is open source. Find it on [GitHub here](https://github.com/uptech/appfit-swift-sdk).
10 changes: 5 additions & 5 deletions docs/swift/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ let configuration = AppFitConfiguration(apiKey: "API_KEY")
let appFit = AppFit(configuration: configuration)
```

Once you have the client constructed, tracking an event is as simple as calling `trackEvent`
Once you have the client constructed, tracking an event is as simple as calling `trackEvent`.

A full example can be found below.

Expand All @@ -28,19 +28,19 @@ appFit.trackEvent(name: "event_name", properties: {"key": "value"})

# Identifying Users

The AppFit SDK includes an `identify` call, that you can use to identify users in your analytic events.
The AppFit SDK includes an `identify` call which can be used to identify users in your analytic events.
This method supports any String-based identifier.

```swift
appfit.identifyUser("<id>")
appfit.identifyUser("USER_ID")
```

Setting this to null, will remove all events going forward from including the userId.
Setting this identifier to null will remove user tracking from all events going forward.

```swift
appfit.identifyUser(nil)
```

# Cached Events

We cache all events locally in the SDK. This allows us to rety failed events. If a device is experiencing network issues, we will retry the saved events later to help avoid losing any metrics.
We cache all event locally in the SDK, allowing us to retry failed events. If a device is experiencing network issues, we will retry events once the device is back online to help avoid event data loss.

0 comments on commit 7b8d039

Please sign in to comment.