Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Former-commit-id: a3ec650 [formerly 8fee22a]
Former-commit-id: 9b47381
  • Loading branch information
akshat-khare authored Mar 12, 2024
1 parent 48da335 commit 8f081c7
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Welcome to InsightXR Analytics SDK for Unity! 🚀

Unlock the full potential of your XR projects with InsightXR Analytics SDK. Designed with developers in mind, this toolkit bridges the gap between immersive experiences and actionable insights. Follow these steps to get started and supercharge your Unity projects with advanced analytics.

## Getting Started

### Step 1: NuGet for Unity

First things first, let's get NuGet for Unity set up. This handy package manager will streamline our SDK setup process. Head over to [NuGetForUnity](https://github.com/GlitchEnzo/NuGetForUnity) and follow the instructions for installation.

### Step 2: AWS SDK S3

Next up, we're integrating AWS SDK S3 version 3.7.3.5.31 to ensure seamless data storage and retrieval. This step is crucial for handling large-scale data efficiently.

### Step 3: Newtonsoft JSON

We'll be using Newtonsoft JSON for all our JSON needs. Install `com.unity.nuget.newtonsoft-json` through the "Install by Name" method within NuGet for Unity. This will help with parsing and generating JSON data effortlessly.

### Step 4: Script Setup

Now, it's time to breathe life into your game objects with our custom scripts. Detailed steps for setting up scripts on your game objects will be provided – stay tuned!

### Step 5: InsightXR Environment Setup

Almost there! Navigate to the InsightXR option in your Unity toolbar and select "Setup Environment." From there, click on "Register Objects" to get your environment prepped and ready for analytics tracking.

And voilà, your script is now configured to track objects with precision. ✨

## Building and Viewing Replays

The final piece of the puzzle is creating WebGL builds and viewing replays to analyze your project's performance. Detailed instructions are on their way, ensuring you have all the tools you need to elevate your XR projects.

## Dive In

You're all set! With InsightXR Analytics SDK, you're not just building games or applications – you're creating data-driven experiences that engage, inform, and impress. We can't wait to see what you build.

Stay tuned for more updates, and happy developing! 🛠️

0 comments on commit 8f081c7

Please sign in to comment.