chark · Edvinas01 · Jan 27, 2021 · Jan 20, 2021 · Jan 20, 2021 · Jan 21, 2021
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,7 @@
+# Contributing
+If you found a bug or want to add a feature, you are more than welcome to make a Pull Request!
+
+When doing so, make sure to:
+- Follow similar code style which is used in other scripts.
+- Add tests cases under [ScriptableEventAttributeTestSource](../Packages/com.chark.scriptable-events/Tests/Editor/ScriptableEventAttributeTestSource.cs) and [ScriptableEventTestSource](../Packages/com.chark.scriptable-events/Tests/Runtime/ScriptableEventTestSource.cs) when adding new event types.
+- Add tests for additional features, for example how [SimpleScriptableEventTest](../Packages/com.chark.scriptable-events/Tests/Runtime/SimpleScriptableEventTest.cs) does it for an additional method that is not covered in [ScriptableEventTest](../Packages/com.chark.scriptable-events/Tests/Runtime/ScriptableEventTest.cs).
diff --git a/.github/README.md b/.github/README.md
@@ -0,0 +1,32 @@
+# Scriptable Events
+[![Unity 2019.4+](https://img.shields.io/badge/unity-2019.4%2B-blue.svg)](https://unity3d.com/get-unity/download)
+[![Actions Status](https://github.com/chark/scriptable-events/workflows/CI/badge.svg)](https://github.com/chark/scriptable-events/actions)
+
+Simple and extensible event system implemented via `ScriptableObject`, based on [Unite2017](https://github.com/roboryantron/Unite2017).
+
+<p align="center">
+  <img hspace="2%" src="event.png"/>
+  <img hspace="2%" src="event-listener.png"/>
+</p>
+
+## Features
+- Can be used with minimal or no code at all.
+- Default event and listener implementations for commonly used types.
+- Strongly typed.
+- Ability to easily add custom events and inspector GUIs.
+
+## Installation
+This package can be installed via the Unity Package Manager by [Installing from a Git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html):
+```text
+https://github.com/chark/scriptable-events.git#upm
+```
+
+Alternatively, you can also install it by adding the following dependency to `Packages/manifest.json`:
+```text
+"com.chark.scriptable-events": "https://github.com/chark/scriptable-events.git#upm"
+```
+
+## Documentation
+- [Usage documentation](../Packages/com.chark.scriptable-events/Documentation~/README.md)
+- [Contributing](CONTRIBUTING.md)
+- [Changelog](../Packages/com.chark.scriptable-events/CHANGELOG.md)
diff --git a/.github/event-listener.png b/.github/event-listener.png
diff --git a/.github/event.png b/.github/event.png
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,3 +1,4 @@
+# TODO: automate based on https://medium.com/openupm/how-to-maintain-upm-package-part-1-7b4daf88d4c4
 name: CI
 
 on:

diff --git a/Assets/CHANGELOG.md b/Assets/CHANGELOG.md
diff --git a/Assets/Documentation~/README.md b/Assets/Documentation~/README.md
diff --git a/Assets/Documentation~/game-events.png b/Assets/Documentation~/game-events.png
diff --git a/Assets/Documentation~/listeners.png b/Assets/Documentation~/listeners.png
diff --git a/Assets/Documentation~/mutable-objects.png b/Assets/Documentation~/mutable-objects.png
diff --git a/Assets/Editor/Chark.UnityScriptableObjects.Editor.asmdef b/Assets/Editor/Chark.UnityScriptableObjects.Editor.asmdef
diff --git a/Assets/Editor/GameEvents/Bool.meta b/Assets/Editor/GameEvents/Bool.meta
diff --git a/Assets/Editor/GameEvents/Bool/BoolGameEventEditor.cs b/Assets/Editor/GameEvents/Bool/BoolGameEventEditor.cs
diff --git a/Assets/Editor/GameEvents/Float.meta b/Assets/Editor/GameEvents/Float.meta
diff --git a/Assets/Editor/GameEvents/Float/FloatGameEventEditor.cs b/Assets/Editor/GameEvents/Float/FloatGameEventEditor.cs
diff --git a/Assets/Editor/GameEvents/Game.meta b/Assets/Editor/GameEvents/Game.meta
diff --git a/Assets/Editor/GameEvents/Game/GameEventEditor.cs b/Assets/Editor/GameEvents/Game/GameEventEditor.cs
diff --git a/Assets/Editor/GameEvents/Game/GameEventEditor.cs.meta b/Assets/Editor/GameEvents/Game/GameEventEditor.cs.meta