Merge pull request #237 from seamapi/npm-instructions-update

NPM Package Name Update
seamapi · Jan 27, 2024 · fe250f5 · fe250f5
2 parents 1d30742 + e2fecaa
commit fe250f5
Show file tree

Hide file tree

Showing 21 changed files with 21 additions and 21 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -19,6 +19,6 @@
       ]
     }
   },
-  "postCreateCommand": "cd /workspaces/api-docs/snippet-playground/javascript && npm i seamapi && cd /workspaces/api-docs/snippet-playground/javascript-next && npm i seam && cd /workspaces/api-docs/snippet-playground/csharp && ./init.sh && cd /workspaces/api-docs/snippet-playground/go && ./init.sh && cd /workspaces/api-docs/snippet-playground/php && composer update",
+  "postCreateCommand": "cd /workspaces/api-docs/snippet-playground/javascript && npm i seam && cd /workspaces/api-docs/snippet-playground/javascript-next && npm i seam && cd /workspaces/api-docs/snippet-playground/csharp && ./init.sh && cd /workspaces/api-docs/snippet-playground/go && ./init.sh && cd /workspaces/api-docs/snippet-playground/php && composer update",
   "remoteUser": "node"
 }
diff --git a/docs/README.md b/docs/README.md
@@ -23,7 +23,7 @@ Use one of the following methods to install the Seam software development kit (S
 {% tabs %}
 {% tab title="JavaScript" %}
 ```bash
-npm i seamapi
+npm i seam
 ```
 {% endtab %}
 

diff --git a/docs/api-clients/installation.md b/docs/api-clients/installation.md
@@ -13,7 +13,7 @@ Install one of the Seam SDKs in the programming language of your choice. Seam su
 {% tabs %}
 {% tab title="JavaScript" %}
 ```bash
-npm i seamapi
+npm i seam
 ```
 
 or

diff --git a/docs/device-guides/get-started-with-2n-intercoms.md b/docs/device-guides/get-started-with-2n-intercoms.md
@@ -21,7 +21,7 @@ Seam provides a universal API to connect and control many brands of smart device
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-august-locks.md b/docs/device-guides/get-started-with-august-locks.md
@@ -14,7 +14,7 @@ Seam provides a universal API to connect and control many brands of smart locks.
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-controlbyweb-devices.md b/docs/device-guides/get-started-with-controlbyweb-devices.md
@@ -14,7 +14,7 @@ Seam provides a universal API to connect and control many brands of smart device
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-dormakaba-oracode-locks.md b/docs/device-guides/get-started-with-dormakaba-oracode-locks.md
@@ -18,7 +18,7 @@ Note that Dormakaba offers multiple lines of products: Lyazon, Sapphire, Oracode
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-ecobee-thermostats.md b/docs/device-guides/get-started-with-ecobee-thermostats.md
@@ -16,7 +16,7 @@ To simplify the examples below, we'll use the following modules and utility vari
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby)) (Thermostats coming soon!)
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php)) (Thermostats coming soon!)

diff --git a/docs/device-guides/get-started-with-igloo-locks.md b/docs/device-guides/get-started-with-igloo-locks.md
@@ -14,7 +14,7 @@ Seam provides a universal API to connect and control many brands of locks, inclu
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-kwikset-wifi-locks.md b/docs/device-guides/get-started-with-kwikset-wifi-locks.md
@@ -24,7 +24,7 @@ To disable MFA, head to **Account Settings** in your Kwikset app:
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-minut-sensors.md b/docs/device-guides/get-started-with-minut-sensors.md
@@ -14,7 +14,7 @@ Seam provides a universal API to connect and control many brands of devices such
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-noiseaware-sensors.md b/docs/device-guides/get-started-with-noiseaware-sensors.md
@@ -16,7 +16,7 @@ To simplify the examples below, we'll use the following modules and utility vari
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-nuki-locks.md b/docs/device-guides/get-started-with-nuki-locks.md
@@ -14,7 +14,7 @@ Seam provides a universal API to connect and control many brands of locks, inclu
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-salto-locks.md b/docs/device-guides/get-started-with-salto-locks.md
@@ -16,7 +16,7 @@ Note that Salto offers multiple lines of products: Salto Space, Salto KS, and Sa
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-schlage-locks.md b/docs/device-guides/get-started-with-schlage-locks.md
@@ -16,7 +16,7 @@ To learn more about other smart lock brands supported by Seam such as August, Ya
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-smartlocks-api.md b/docs/device-guides/get-started-with-smartlocks-api.md
@@ -20,7 +20,7 @@ Let's get started.
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-ttlock-devices.md b/docs/device-guides/get-started-with-ttlock-devices.md
@@ -14,7 +14,7 @@ Seam provides a universal API to connect and control many brands of locks, inclu
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-wyze-locks.md b/docs/device-guides/get-started-with-wyze-locks.md
@@ -22,7 +22,7 @@ For **Bluetooth-only Wyze Lock Bolts** we're not able to control the lock remote
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/device-guides/get-started-with-yale-locks.md b/docs/device-guides/get-started-with-yale-locks.md
@@ -16,7 +16,7 @@ To learn more about other smart lock brands supported by Seam such as August, Sc
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -59,7 +59,7 @@ Seam supports many programming languages, such as the following:
 {% tabs %}
 {% tab title="JavaScript" %}
 ```bash
-npm i seamapi
+npm i seam
 ```
 {% endtab %}
 

diff --git a/...ponents/overview/get-started-with-react-components-and-client-session-tokens.md b/...ponents/overview/get-started-with-react-components-and-client-session-tokens.md
@@ -22,7 +22,7 @@ A Client Session Token allows a device owner to make API requests to Seam where
 
 Seam provides client libraries for many languages such as Javascript, Python, Ruby, and PHP, as well as a Postman collection and [OpenAPI](https://connect.getseam.com/openapi.json) spec.
 
-* **Javascript:** `npm i seamapi` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
+* **Javascript:** `npm i seam` ([npm](https://www.npmjs.com/package/seamapi), [github](https://github.com/seamapi/javascript))
 * **Python:** `pip install seamapi` ([pip](https://pypi.org/project/seamapi/), [github](https://github.com/seamapi/python))
 * **Ruby:** `bundle add seamapi` ([rubygem](https://rubygems.org/gems/seamapi), [github](https://github.com/seamapi/ruby))
 * **PHP:** `composer require seamapi/seam` ([packagist](https://packagist.org/packages/seamapi/seam), [github](https://github.com/seamapi/php))