From 19ad9df8953aaac8bcef932da3f319faf73d352e Mon Sep 17 00:00:00 2001 From: Natalie Bunduwongse Date: Thu, 7 Sep 2023 09:13:07 +1200 Subject: [PATCH] docs: update readme --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 82c8ad58..8c7f9664 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,6 @@ # Immutable Unity SDK -## Prerequisites - -- [git-lfs](https://git-lfs.github.com/): since `.dll` files are stored on Git Large File Storage, you must download and install git-lfs from [here](https://git-lfs.github.com/). - ## Supported Platforms
  • Windows (64-bit)
  • @@ -31,6 +27,10 @@ See [here](https://docs.immutable.com/docs/x/passport/register-application) for ## Installation +> :warning: Prerequisites +> +>[git-lfs](https://git-lfs.github.com/): since `.dll` files are stored on Git Large File Storage, you must download and install git-lfs from [here](https://git-lfs.github.com/). + 1. Clone the [unity-immutable-sdk](https://github.com/immutable/unity-immutable-sdk) repository or download the zip/tarball from one of the versions [here](https://github.com/immutable/unity-immutable-sdk/tags) 2. Open the Package Manager 3. Click the add + button and select "Add package from disk..." @@ -44,11 +44,20 @@ See [here](https://docs.immutable.com/docs/x/passport/register-application) for Create a script with the following code and bind it to an object: ```csharp -public class ImmutableUnity : MonoBehaviour +using System.Collections; +using System.Collections.Generic; +using UnityEngine; +using Immutable.Passport; + +public class InitPassport : MonoBehaviour { - void Start() + private Passport passport; + + async void Start() { - Passport passport = await Passport.Init("YOUR_IMMUTABLE_CLIENT_ID"); + string clientId = "YOUR_IMMUTABLE_CLIENT_ID"; + string environment = Immutable.Passport.Model.Environment.SANDBOX; + passport = await Passport.Init(clientId, environment); } } ```