Merge pull request #52 from asadm/documentation-update

docs: add documentation, templates

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,42 @@
+name: Bug Report
+description: File a bug report.
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - SaadBazaz
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: textarea
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software are you running?
+      placeholder: x.x.x
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: What is your environment?
+      description: Describe your project's environment. This will help us reproduce the issue.
+      placeholder: Unity version, Browser, Operating System, etc
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature.yaml

@@ -0,0 +1,16 @@
+name: Suggest an improvement!
+description: Do you want to see something better in the Unity SDK?
+title: "[Feature-Request]: "
+labels: ["enhancement", "triage"]
+assignees:
+  - asadm
+body:
+  - type: textarea
+    id: enhancement-description
+    attributes:
+      label: What do you want to see?
+      description: Also tell us, what alternatives have you tried?
+      placeholder: Tell us what you want!
+      value: "Better developer experience!"
+    validations:
+      required: true

readme.md

@@ -1,7 +1,35 @@
-### PlayroomKit SDK for Unity
+<div align="center">
+    <img src="https://docs.joinplayroom.com/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Funity-blog.16612f8c.png&w=3840&q=75" width="100%" style="border-radius: 12px">
+    <h1 style="margin-top:8px">PlayroomKit SDK for Unity</h1>
+   <p>The easiest multiplayer infrastructure for the web</p>
+   <a href="https://docs.joinplayroom.com/usage/unity"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000&style=for-the-badge" /></a>
+   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
+   <a href="https://discord.gg/HGkSRAD8"><img src="https://img.shields.io/static/v1?label=Discord&message=Join&color=7289da&style=for-the-badge" /></a>
+</div>
 
-This SDK is a wrapper over PlayroomKit JS. Currently, it only supports WebGL exported games.
-See [PlayroomKit Unity docs](https://docs.joinplayroom.com/usage/unity) for more information.
+<br/>
+<br/>
+
+This SDK is a wrapper over PlayroomKit JS. Currently, it only supports WebGL exported games. The API is meant to closely mirror the PlayroomKit JavaScript SDK.
+
+<!-- Start SDK Installation -->
+## Installation and Usage
+
+See [PlayroomKit Unity docs](https://docs.joinplayroom.com/usage/unity) on how to use this SDK in your Unity project.
+
+
+This beta version of the SDK might undergo changes that could break compatibility with previous versions, even without a major version update. To ensure stability, it's advisable to fix the usage to a particular package version. By doing so, you'll consistently install the same version and avoid unexpected changes, unless you deliberately seek the latest updates.
+
+<!-- End SDK Installation -->
+
+<!-- Start SDK Installation -->
+## Contribution
+
+### Reporting issues
+
+You can search for help, or ask the community, in our [Discord channel](https://discord.gg/HGkSRAD8).
+
+Found a bug, or want us to implement something? [Create an Issue](https://github.com/asadm/playroom-unity/issues/new) on GitHub.
 
 ### Creating a new release
 
@@ -12,4 +40,11 @@ git tag v0.Y.Z
 git push origin --tags
 ```
 
-This will create a draft release [on GitHub](https://github.com/asadm/playroom-unity/releases). Edit the release to add release notes and publish it.
+This will create a draft release [on GitHub](https://github.com/asadm/playroom-unity/releases). Edit the release to add release notes and publish it.
+
+### Learn more
+
+Read more about the PlayroomKit Unity integration and the design behind it.
+
+- [Official announcement blog](https://docs.joinplayroom.com/blog/unityweb)
+- [Deep dive into PlayroomKit Unity](https://www.linkedin.com/pulse/building-unity-plugin-javascript-grayhatpk-gynfc/?trackingId=kbv0oZVNT6aLh2TjQ%2FhuVw%3D%3D)