Update README and fix player module usings (#37)

* Update player module usings

* Update branding

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+Please refer to the package's [Releases GitHub Page](https://github.com/realitycollective/com.realitytoolkit.metaplatform/releases) for the changelog.

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 Reality Collective
+Copyright (c) 2022-2024 Reality Collective
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,52 +1,36 @@
 # Reality Toolkit - Meta
 
-![GitHub](https://user-images.githubusercontent.com/9565734/202870362-1dd49fc0-7475-4b3f-b51c-be42f34cff6c.png)
+![com.realitytoolkit.metaplatform](https://github.com/realitycollective/realitycollective.logo/blob/main/RealityToolkit/RepoBanners/com.realitytoolkit.metaplatform.png?raw=true)
 
-The [Meta](https://www.meta.com/) platform components for the [Reality Toolkit](https://github.com/realitycollective/com.realitytoolkit.core).
-This package enables your Reality Toolkit based project to run on Meta devices.
+The Meta platform components for the Reality Toolkit. This package enables your [Reality Toolkit](https://www.realitytoolkit.io/) based project to run on Meta devices.
 
-[![openupm](https://img.shields.io/npm/v/com.realitytoolkit.metaplatform?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.realitytoolkit.metaplatform/)
+[![openupm](https://img.shields.io/npm/v/com.realitytoolkit.metaplatform?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.realitytoolkit.metaplatform/) [![Discord](https://img.shields.io/discord/597064584980987924.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/hF7TtRCFmB)
+[![Publish main branch and increment version](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/main-publish.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/main-publish.yml)
+[![Publish development branch on Merge](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/development-publish.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/development-publish.yml)
+[![Build and test UPM packages for platforms, all branches except main](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/development-buildandtestupmrelease.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/development-buildandtestupmrelease.yml)
 
-[![Discord](https://img.shields.io/discord/597064584980987924.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/hF7TtRCFmB)
+## Installation
 
-## What is included?
+Make sure to always use the same source for all toolkit modules. Avoid using different installation sources within the same project. We provide the following ways to install Reality Toolkit modules:
 
-- Service modules for the Reality Toolkit's camera service
-- Service modules for the Reality Toolkit's input service
-- Service modules for the Reality Toolkit's boundary service
+### Method 1: Using Package Manager for git users
 
-## Supported Devices
+1. Open the Package Manager using the Window menu -> Package Manager
 
-- Meta Quest
-- Meta Quest 2
-- Meta Quest Pro
+2. Inside the Package Manager, click on the "+" button on the top left and select "Add package from git URL..."
 
-## Requirements
+3. Input the following URL: https://github.com/realitycollective/com.realitytoolkit.metaplatform.git and click "Add".
 
-- [RealityToolkit.Core](https://github.com/realitycollective/com.realitytoolkit.core)
-- [Unity 2020.3 and above](https://unity.com/)
-- [OpenUPM](https://openupm.com/docs/)
-
-## Getting Started
-
-Visit [OpenUPM](https://openupm.com/docs/) to learn more about it. Once you have the OpenUPM CLI set up use the following command to add the package to your project:
+### Method 2: OpenUPM
 
 ```text
     openupm add com.realitytoolkit.metaplatform
 ```
 
-If you already have an instance of the Reality Toolkit in your scene, then installing this package will automatically add the Meta modules to your configuration profile.
+### Method 3: Unity Asset Store
 
-## Community
+This option will be available soon.
 
-Join our community and get in touch with other developers.
-
-- [Discord](https://discord.gg/hF7TtRCFmB)
-
-## Build Status
-<!-- Check build status links and details -->
+## Getting Started
 
-| branch | build status |
-| --- | --- |
-| main | [![main](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/main-publish.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/main-publish.yml) |
-| development | [![development](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/development-buildandtestupmrelease.yml/badge.svg)](https://github.com/realitycollective/com.realitytoolkit.metaplatform/actions/workflows/development-buildandtestupmrelease.yml)|
+Check the ["Getting Started"](https://www.realitytoolkit.io/) documentation for the Reality Toolkit and to learn more about this module.

Runtime/InputService/Utilities/MetaHandDataConverter.cs

@@ -4,12 +4,12 @@
 using RealityCollective.Definitions.Utilities;
 using RealityCollective.Extensions;
 using RealityCollective.ServiceFramework.Services;
-using RealityToolkit.PlayerService.Interfaces;
 using RealityToolkit.Definitions.Devices;
 using RealityToolkit.Input.Hands;
 using RealityToolkit.Input.Hands.Utilities;
 using RealityToolkit.MetaPlatform.InputService.Extensions;
 using RealityToolkit.MetaPlatform.Plugins;
+using RealityToolkit.Player.Interfaces;
 using System;
 using System.Collections.Generic;
 using UnityEngine;

Runtime/PlayerService/IMetaPlayerRigServiceModule.cs

@@ -1,7 +1,7 @@
 // Copyright (c) Reality Collective. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using RealityToolkit.PlayerService.Interfaces;
+using RealityToolkit.Player.Interfaces;
 
 namespace RealityToolkit.MetaPlatform.PlayerService
 {

Runtime/PlayerService/MetaPlayerRigServiceModule.cs

@@ -2,10 +2,10 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using RealityCollective.ServiceFramework.Attributes;
-using RealityToolkit.PlayerService.Definitions;
-using RealityToolkit.PlayerService.Interfaces;
-using RealityToolkit.PlayerService.Modules;
 using RealityToolkit.MetaPlatform.Plugins;
+using RealityToolkit.Player.Definitions;
+using RealityToolkit.Player.Interfaces;
+using RealityToolkit.Player.Modules;
 
 namespace RealityToolkit.MetaPlatform.PlayerService
 {

package.json

@@ -31,8 +31,8 @@
     "url": "https://github.com/realitycollective"
   },
   "dependencies": {
-    "com.realitytoolkit.core": "1.0.0-pre.29",
-    "com.realitytoolkit.player": "1.0.1-pre.5",
+    "com.realitytoolkit.core": "1.0.0-pre.37",
+    "com.realitytoolkit.player": "1.0.3-pre.1",
     "com.realitytoolkit.boundary": "1.0.0-pre.1",
     "com.unity.xr.oculus": "3.3.0"
   },