A first documentation to README

Add separate sample projects for core and proto

Author: mduesterhoeft

README.md

@@ -5,3 +5,51 @@
 # lambda-kotlin-request-router
 
 A REST request routing layer for AWS lambda handlers written in Kotlin.
+
+## Goal
+
+We came up `lambda-kotlin-request-router` to reduce boilerplate code when implementing a REST API handlers on AWS Lambda.
+
+The library addresses the following aspects:
+
+- serialization and deserialization
+- provide useful extensions and abstractions for API Gateway request and response types
+- writing REST handlers as functions
+- ease implementation of cross cutting concerns for handlers
+- ease (local) testing of REST handlers
+
+## Getting Started
+
+To use the core module we need the following:
+
+```groovy
+repositories {
+    maven { url 'https://jitpack.io' }
+}
+
+dependencies {
+    implementation 'com.github.moia-dev.lambda-kotlin-request-router:router:0.3.1' 
+}
+
+```
+
+Having this we can now go ahead and implement our first handler.
+We can implement a request handler as a simple function.
+Request and response body are deserialized and serialized for you.
+
+```kotlin
+import io.moia.router.Request
+import io.moia.router.RequestHandler
+import io.moia.router.ResponseEntity
+import io.moia.router.Router.Companion.router
+
+class MyRequestHandler : RequestHandler() {
+
+    override val router = router {
+        GET("/some") { r: Request<String> -> ResponseEntity.ok(MyResponse(r.body)) }
+    }
+}
+```
+
+
+

sample/.DS_Store renamed to samples/lambda-kotlin-request-router-sample-proto/.DS_Store

@@ -1,10 +1,11 @@
+
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import com.github.jengelman.gradle.plugins.shadow.transformers.Log4j2PluginsCacheFileTransformer
-import java.net.URI
-import java.util.concurrent.TimeUnit.SECONDS
 import com.google.protobuf.gradle.protobuf
 import com.google.protobuf.gradle.protoc
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import java.net.URI
+import java.util.concurrent.TimeUnit.SECONDS
 
 
 buildscript {
@@ -59,9 +60,9 @@ tasks {
     }
 
     withType<ShadowJar> {
-        baseName = project.name
-        classifier = ""
-        version = ""
+        archiveBaseName.set(project.name)
+        archiveClassifier.set("")
+        archiveVersion.set("")
         transform(Log4j2PluginsCacheFileTransformer::class.java)
     }
 

sample/build.gradle.kts renamed to samples/lambda-kotlin-request-router-sample-proto/build.gradle.kts

@@ -0,0 +1,20 @@
+service: request-router-sample-proto # NOTE: update this with your service name
+
+provider:
+  name: aws
+  runtime: java8
+  region: eu-west-1
+
+package:
+  artifact: build/libs/lambda-kotlin-request-router-sample-proto.jar
+
+functions:
+  my-handler:
+    handler: io.moia.router.sample.MyRequestHandler
+    events:
+      - http:
+          path: some
+          method: get
+      - http:
+          path: some
+          method: post

sample/gradle/wrapper/gradle-wrapper.jar renamed to samples/lambda-kotlin-request-router-sample-proto/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1 @@
+rootProject.name = 'lambda-kotlin-request-router-sample-proto'

sample/gradle/wrapper/gradle-wrapper.properties renamed to samples/lambda-kotlin-request-router-sample-proto/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,19 @@
+package io.moia.router.sample
+
+import io.moia.router.Request
+import io.moia.router.ResponseEntity
+import io.moia.router.Router.Companion.router
+import io.moia.router.proto.ProtoEnabledRequestHandler
+import io.moia.router.proto.sample.SampleOuterClass.Sample
+
+class MyRequestHandler : ProtoEnabledRequestHandler() {
+    private val controller = SomeController()
+
+    override val router = router {
+        // functions can be externalized...
+        GET("/some", controller::get)
+
+        // simple handlers can also be declared inline
+        POST("/some") { r: Request<Sample> -> ResponseEntity.ok(r.body) }
+    }
+}