@doordeck/doordeck-headless-sdk 0.42.0 → 0.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,2 +1,30 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
# Doordeck Headless SDK
|
|
2
|
+
A cross-platform SDK for seamless access to Doordeck’s services. This SDK supports multiple platforms and is designed to cater to a variety of development environments.
|
|
3
|
+
|
|
4
|
+
## Packages
|
|
5
|
+
We are publishing the packages to multiple repositories:
|
|
6
|
+
|
|
7
|
+
| Platform | Repository |
|
|
8
|
+
|:---------------------------:|----------------------------------------------------------------------------------------------------------------------|
|
|
9
|
+
| Multiplatform, Android, JVM | [Maven central](https://central.sonatype.com/namespace/com.doordeck.headless.sdk) |
|
|
10
|
+
| iOS, macOS | [Cocoapods](https://cocoapods.org/pods/DoordeckSDK), [SPM](https://github.com/doordeck/doordeck-headless-sdk-spm) |
|
|
11
|
+
| JS | [NPM](https://www.npmjs.com/package/@doordeck/doordeck-headless-sdk) |
|
|
12
|
+
| Windows | //TODO |
|
|
13
|
+
|
|
14
|
+
## Supported platforms
|
|
15
|
+
The SDK supports a range of targets for different platforms:
|
|
16
|
+
|
|
17
|
+
| Platform | Target |
|
|
18
|
+
|:--------:|-------------------------------------------|
|
|
19
|
+
| Android | `android` |
|
|
20
|
+
| JVM | `jvm` |
|
|
21
|
+
| iOS | `iosX64`, `iosArm64`, `iosSimulatorArm64` |
|
|
22
|
+
| macOS | `macosArm64` |
|
|
23
|
+
| JS | `jsNode`, `jsBrowser` |
|
|
24
|
+
| Windows | `mingwX64` |
|
|
25
|
+
|
|
26
|
+
## Getting started
|
|
27
|
+
To start using the Doordeck Headless SDK, refer to the [documentation index](https://github.com/doordeck/doordeck-headless-sdk/blob/main/docs/01_INDEX.md#index) for detailed setup and usage instructions tailored to your platform.
|
|
28
|
+
|
|
29
|
+
## Samples
|
|
30
|
+
We provide samples for different targets, where you can see how the SDK can be used in fully functional projects. For more information, please see the [samples page](docs/15_SAMPLES.md).
|