Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

Commit

Permalink
remove public reference to the word "Satellite"
Browse files Browse the repository at this point in the history
  • Loading branch information
rsoury committed Jul 5, 2022
1 parent b27df39 commit eec0a56
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Usher Satellite: Browser JS Conversion Tracking Library
# UsherJS: Browser JS Conversion Tracking Library

This library **does not work in Node.js environments**. It is designed for web browsers **only** (*for now*). You should ensure that your application does not attempt to package and run this on a server.

## Getting Started

```
npm i @usher.so/satellite
npm i @usher.so/js
```
OR
```
yarn add @usher.so/satellite
yarn add @usher.so/js
```

Using Import:
```javascript
import { Usher } from '@usher.so/satellite'
import { Usher } from '@usher.so/js'
Usher('convert', {
id: "ida4Pebl2uULdI_rN8waEw65mVH9uIFTY1JyeZt1PBM",
chain: "arweave",
Expand All @@ -30,7 +30,7 @@ Usher('convert', {

Loading directly into Browser:
```html
<script src="https://cdn.jsdelivr.net/npm/@usher.so/satellite"></script>
<script src="https://cdn.jsdelivr.net/npm/@usher.so/js"></script>
<script>
window.Usher('convert', {
id: "ida4Pebl2uULdI_rN8waEw65mVH9uIFTY1JyeZt1PBM",
Expand All @@ -48,9 +48,9 @@ Loading directly into Browser:

## Documentation

- Integrate Usher Satellite: [https://docs.usher.so](https://docs.usher.so)
- Usher Satellite Typescript Docs: [https://ts-docs.satellite.usher.so](https://ts-docs.satellite.usher.so)
- View integration example: [See file](https://github.com/usherlabs/satellite/blob/master/tools/index.html)
- Integrate UsherJS: [https://docs.usher.so](https://docs.usher.so)
- UsherJS Typescript Docs: [https://ts-docs.js.usher.so](https://ts-docs.js.usher.so)
- View integration example: [See file](https://github.com/usherlabs/usher.js/blob/master/tools/index.html)
- Learn about Usher: [https://usher.so](https://usher.so)

## API
Expand All @@ -68,15 +68,15 @@ Loading directly into Browser:

Use this event name with `window.Usher` to trigger a conversion.

**params:** `Conversion` -- [See Type](https://ts-docs.satellite.usher.so/types/types.conversion)
**params:** `Conversion` -- [See Type](https://ts-docs.js.usher.so/types/types.conversion)

### `onLoad`

**params:** `() => void`

### `onConversion`

**params:** `ConversionCallback` -- [See Type](https://ts-docs.satellite.usher.so/types/types.conversioncallback)
**params:** `ConversionCallback` -- [See Type](https://ts-docs.js.usher.so/types/types.conversioncallback)

Register a callback to fire after a conversion has been successfully tracked.

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@usher.so/satellite",
"name": "@usher.so/js",
"version": "0.1.0",
"description": "Usher Satellite Library used for integrating Conversion Tracking",
"description": "UsherJS Library used for integrating Conversion Tracking",
"author": "Ryan Soury <[email protected]>",
"homepage": "https://usher.so/",
"license": "MIT",
Expand All @@ -15,7 +15,7 @@
"types": "index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/usherlabs/satellite.git"
"url": "https://github.com/usherlabs/usher.js.git"
},
"publishConfig": {
"access": "public",
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://json.schemastore.org/tsconfig",
"display": "Satellite",
"display": "UsherJS",
"compilerOptions": {
"baseUrl": ".",
"preserveConstEnums": true,
Expand Down

0 comments on commit eec0a56

Please sign in to comment.