Skip to content

Commit fc439b0

Browse files
committed
make docs clearer about MV3
1 parent c4b8d73 commit fc439b0

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/getting-started.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,16 @@ Don't forget to register for an AppId to run your app in production, it's quick
1515
## Quick Start
1616

1717
Get your AppId here: [`🌎 AppId Registration`](https://www.inboxsdk.com/register)
18-
Download the SDK here: [`⬇️ inboxsdk.js`](https://www.inboxsdk.com/build/inboxsdk.js)
1918

20-
:::tip MV3 Compatible Beta now on NPM
21-
New beta of `inboxsdk.js` available on NPM that is compatible with Manifest V3 and doesn't use remote loading [See Announcement](https://groups.google.com/g/inboxsdk/c/MAT_zImFu5I/m/N_7nDojRAgAJ)
19+
:::tip MV3 Compatible Version now on NPM
20+
The InboxSDK is now available on NPM in a Chrome MV3-compatible form which does not use remote loading. This Getting Started page is still being updated for the NPM version. Please see instead the [Hello World example extension GitHub repo](https://github.com/InboxSDK/hello-world) and the [NPM version announcement post](https://groups.google.com/g/inboxsdk/c/MAT_zImFu5I/m/N_7nDojRAgAJ).
2221
:::
2322

24-
### Hello World! Sample Extension
23+
**The instructions below referring to `inboxsdk.js` are currently mostly about the non-NPM Chrome MV2 compatible release that uses remote code loading.**
24+
25+
Download the SDK here: [`⬇️ inboxsdk.js`](https://www.inboxsdk.com/build/inboxsdk.js)
26+
27+
### Hello World! Sample MV2 Extension
2528

2629
Here's how simple it is to build a basic app, you need two files: `myapp.js` which is your application code that interacts with the SDK, and the `manifest.json` which describes a basic Chrome extension.
2730

@@ -291,5 +294,6 @@ InboxSDK.load(2, 'YOUR_APP_ID_HERE').then(function(sdk){
291294
});
292295
});
293296
```
297+
294298
### Compatibility
295299
The SDK is currently at version 2 and when loading the SDK that is the number you should specify. The SDK may add backwards compatible API's to the current version, but incompatible changes will come with a version update. Your code is guranteed to work so long as you specify the correct version number AND that version number is at most two releases old.

0 commit comments

Comments
 (0)