Merge pull request #3 from Loop312/test

Test

Author: Loop312

README.md

@@ -1,3 +1,64 @@
+# Usage
+
+*MUST USE WITH COMPOSE MULTIPLATFORM*
+### build.gradle.kts
+
+```kotlin
+kotlin {
+    //...
+    sourceSets {
+        //...
+        commonMain.dependencies {
+            //...
+            //Format: groupId:artifactId:version
+            //groupId = io.github.loop312
+            //artifactId = compose-keyhandler
+            //version = 0.2.1 (choose latest version instead)
+            implementation("io.github.loop312:compose-keyhandler:0.2.1")
+        }
+    }
+}
+```
+
+```kotlin
+implementation("io.github.loop312:compose-keyhandler:0.2.0") 
+```
+
+### Common Main
+```kotlin
+//import ...
+/*
+import io.github.loop312.compose_keyhandler.KeyHandler
+or for more fine control of the variables
+import io.github.compose_keyhandler.*
+*/
+
+//doesn't need to be outside main function
+val keyHandler = KeyHandler()
+
+keyHandler.addKey(Key.A){
+    println("A is being pressed")
+    //or any other action you want to do
+}
+
+fun main() {
+    Box(Modifier.onKeyEvent(keyHandler.listen)) {
+        //...
+    }
+    keyHandler.activate()
+}
+```
+
+## Method
+
+- maps a key to an action
+- whenever a key is pressed, it gets added to a set
+- whenever a key is released, it gets removed from the set
+- while the key is pressed, the action is executed
+
+
+# Came With Project Structure
+
 [![official project](http://jb.gg/badges/official.svg)](https://github.com/JetBrains#jetbrains-on-github)
 
 # Multiplatform library template

compose-keyhandler/build.gradle.kts

@@ -15,7 +15,7 @@ plugins {
 }
 
 group = "io.github.loop312"
-version = "0.2.0"
+version = "0.2.1"
 
 kotlin {
     androidTarget {

compose-keyhandler/src/commonMain/kotlin/io/github/compose_keyhandler/App.kt

@@ -22,7 +22,7 @@ fun App() {
     MaterialTheme {
         var showContent by remember { mutableStateOf(false) }
         Column(Modifier.fillMaxWidth(), horizontalAlignment = Alignment.CenterHorizontally) {
-            Button(onClick = { showContent = !showContent }, Modifier.onKeyEvent(lol.listener)) {
+            Button(onClick = { showContent = !showContent }, Modifier.onKeyEvent(lol.listen)) {
                 Text("Click me!")
             }
             lol.activate()

compose-keyhandler/src/commonMain/kotlin/io/github/compose_keyhandler/KeyHandler.kt

@@ -16,8 +16,8 @@ class KeyHandler {
         keys += mapOf(key to action)
     }
 
-    //use modifier = "Modifier.onKeyEvent(KeyHandler.listener)"
-    val listener = { event: KeyEvent ->
+    //use modifier = "Modifier.onKeyEvent(KeyHandler.listen)"
+    val listen = { event: KeyEvent ->
         //when a button is pressed add it to pressedKeys and when it's released remove it
         when (event.type) {
             KeyEventType.KeyDown -> {