DX-2223: Readme instructions for getting started (#2)

* DX-2223: Readme instructions for getting started

* Updated logout image

* DX-2223: Added Changelog

* DX-2223: Added Immutable logo

* Removed

* PR Feedback

* reorder of sections in readme

* PR Feedback

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2023-08-23
+
+### Added
+
+- Initial release of the Immutable Unreal SDK Plugin.

README.md

@@ -1,7 +1,29 @@
-# Immutable SDK for Unreal 
+<div align="center">
+  <p align="center">
+    <a  href="https://docs.x.immutable.com/docs">
+      <img src="https://cdn.dribbble.com/users/1299339/screenshots/7133657/media/837237d447d36581ebd59ec36d30daea.gif" width="280"/>
+    </a>
+  </p>
+</div>
+
+---
+
+# Immutable SDK for Unreal Engine
 
 ## User Guide
 
+### Supported Platforms
+
+- Windows 10 (64-bit)
+- MacOS
+
+### Supported Unreal Engine Versions
+
+- Unreal Engine 5.0 and above
+
+> [!NOTE]
+> Support for Unreal Engine 4.27 work is currently underway.
+
 ### Installation
 
 To install the plugin download it into your project's `Plugins` folder, e.g.: `MyGame/Plugins/unreal-immutable-sdk`.
@@ -16,22 +38,63 @@ See the included sample widgets in `All`->`Plugins`->`Immutable Content` in the
 
 See `ImmutablePassport.h` for the C++ Passport API.  Follow the same sequence of steps as the Blueprint widget example to initialise and connect Passport and retrieve account data.
 
+### Quick Start
+
+#### Passport Login Flow
+
+See this Blueprint showing how to login to passport ![Passport Login Blueprint](PassportLoginFlow.jpg)
+
+Here are the steps to login to passport:
+
+1. `Initialise Passport` to initialise passport instance.
+2. Check if there are stored credentials from previous login.
+3. If stored credentials found, `ConnectSilent` uses the saved credentials to login to Passport.
+4. When no stored credentials found or step 3 fails, attempt to make a new Connection to login to Passport using `Connect`. This will open the gamer's default browser and take them through the auth flow.
+
+Once the gamer is connected to Passport, the SDK will store your credentials (access, ID, and refresh tokens).
+
+> [!NOTE]
+> We use the [Device Code Authorisation](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow#:~:text=Your%20Auth0%20Authorization%20Server%20redirects,authorized%20to%20access%20the%20API.) flow to authenticate and authorise gamers.
+
+#### Log out of Passport
+
+See this Blueprint showing how to logout from passport ![Passport Logout Blueprint](PassportLogoutFlow.jpg)
+
+## Supported Functionality
+
+
+| Method	                | Description |
+|---	                    |:---|
+| GetAddress	            | Gets Wallet Address |
+| GetEmail	                | Get Email Address associated with the Wallet Address |
+| CheckStoredCredentials	| Checks if there are stored credits from previous login |
+| Connect	                | New login connection |
+| ConnectSilent	            | Attempts to login using stored credentials |
+
+
+See the [ImmutablePassport.h](https://github.com/immutable/unreal-immutable-sdk/blob/dc39324db204f2ba30e9c9f0ca25c070987785cb/Source/Immutable/Public/Immutable/ImmutablePassport.h#L115C8-L115C8) header for the full API.
+
+## Examples
+
+- **Sample Blueprints** - see the [sample blueprints](https://github.com/immutable/unreal-immutable-sdk/tree/main/Content/BlueprintSampleContent) for examples of how to use the Immutable Unity SDK.
+
+- **Sample Game** - see the [sample game](https://github.com/immutable/sample-unreal-game) for example of how to use the Immutable Unity SDK.
 
 ## Plugin Maintainers' Guide
 
 ### Prerequisites
 
-- Windows 10 or 11
 - git
 - Epic Games Launcher
 - Unreal Engine installed from the Epic Games Launcher; you will need every version that the plugin supports (currently 4.27, 5.0, 5.1, 5.2)
 - Visual Studio 2022 with C++ support
+- Jetbrains Rider IDE (recommended for working with Unreal Engine C++ code)
 
-The Jetbrains Rider IDE is recommended for working with Unreal Engine C++ code.  If not Rider, Visual Studio is fine and even better with the Resharper plugin.
+If not Rider, Visual Studio is fine and even better with the Resharper plugin.
 
 ### Getting Started
 
-See user docs to install the plugin, with one caveat:  If you want to open the project and plugin in an IDE you'll need to create your Unreal project as a C++ project.  If you've already accidentally created your Unreal project as BluePrint-only you can convert it to a BluePrint-and-C++ project by adding any C++ class from the `Add New C++ Class` option in the Unreal Editor's `File` menu.
+See [user guide](#user-guide) to install the plugin, with one caveat:  If you want to open the project and plugin in an IDE you'll need to create your Unreal project as a C++ project.  If you've already accidentally created your Unreal project as BluePrint-only you can convert it to a BluePrint-and-C++ project by adding any C++ class from the `Add New C++ Class` option in the Unreal Editor's `File` menu.
 
 ### Debugging the Embedded Browser
 
@@ -49,7 +112,75 @@ To set up Chromium remote debugging, edit project build/launch configurations in
 
 Next, launch the game and then open a separate Chrome/Chromium browser and navigate to `chrome://inspect` where your app should be listed, sometimes intermittently or after a delay, under the `Remote Target #localhost` section.  Click `inspect` to launch the remote debugging session.
 
-#### Displaying the Browser
+## Changelog Management
+
+The following headings should be used as appropriate.
+
+- Added
+- Changed
+- Deprecated
+- Removed
+- Fixed
+
+What follows is an example with all the change headings, for real world use only use headings when appropriate.
+This goes at the top of the CHANGELOG.md above the most recent release.
+
+```markdown
+...
+
+## [Unreleased]
+
+### Added
+
+for new features.
+
+### Changed
+
+for changes in existing functionality.
+
+### Deprecated
+
+for soon-to-be removed features.
+
+### Removed
+
+for now removed features.
+
+### Fixed
+
+for any bug fixes.
+
+...
+```
+
+## Contributing
+
+If you would like to contribute, please read the following:
+
+- We use the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#specification) when writing our commit messages. Why use Conventional Commits? Read [here](https://www.conventionalcommits.org/en/v1.0.0/#why-use-conventional-commits).
+
+## Getting Help
+
+Immutable X is open to all to build on, with no approvals required. If you want to talk to us to learn more, or apply for developer grants, click below:
+
+[Contact us](https://www.immutable.com/contact)
+
+### Project Support
+
+To get help from other developers, discuss ideas, and stay up-to-date on what's happening, become a part of our community on Discord.
+
+[Join us on Discord](https://discord.gg/TkVumkJ9D6)
+
+You can also join the conversation, connect with other projects, and ask questions in our Immutable X Discourse forum.
+
+[Visit the forum](https://forum.immutable.com/)
+
+#### Still need help?
+
+You can also apply for marketing support for your project. Or, if you need help with an issue related to what you're building with Immutable X, click below to submit an issue. Select _I have a question_ or _issue related to building on Immutable X_ as your issue type.
+
+[Contact support](https://support.immutable.com/hc/en-us/requests/new)
 
-**TODO**
+## License
 
+Immutable Unity SDK repository is distributed under the terms of the [Apache License (Version 2.0)](LICENSE).