From 5ad7c2ee5e79b0c1d7ffa176bcbaed8de1e35d5f Mon Sep 17 00:00:00 2001
From: James Bradlee <james.bradlee@telenor.no>
Date: Fri, 22 Mar 2024 10:56:39 +0100
Subject: [PATCH] docs: added more info in readme and a license file

---
 .idea/.gitignore |  2 ++
 LICENSE          | 21 +++++++++++++++++++++
 README.md        | 22 +++++++++++++++++++---
 3 files changed, 42 insertions(+), 3 deletions(-)
 create mode 100644 LICENSE

diff --git a/.idea/.gitignore b/.idea/.gitignore
index 13566b8..a9d7db9 100644
--- a/.idea/.gitignore
+++ b/.idea/.gitignore
@@ -6,3 +6,5 @@
 # Datasource local storage ignored files
 /dataSources/
 /dataSources.local.xml
+# GitHub Copilot persisted chat sessions
+/copilot/chatSessions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c8d1cdf
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Telenor Norway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index b8f011c..f3f45e9 100644
--- a/README.md
+++ b/README.md
@@ -11,20 +11,36 @@ In your gradle file
 
 _Follow [this guide](https://github.com/telenornorway/sh.tnn) on how to set up your environment for GitHub packages._
 
+<!-- @formatter:off -->
 ```kt
+// build.gradle.kts
 plugins {
-	id("sh.tnn") version "0.2.0"
+    id("sh.tnn") version "0.2.0"
+}
+
+repositories {
+    mavenCentral()
+    // provided by the sh.tnn plugin
+    telenor.public()
+}
+
+dependencies {
+    implementation("no.telenor.kt:restclient-utils:0.3.0")
 }
 ```
+<!-- @formatter:on -->
 
 ## Usage
 
+The source code itself is the best documentation, if you are wondering what this library does,
+just take a look at the source code to find everything you need.
+
 <!-- @formatter:off -->
 ```kt
 import no.telenor.kt.restclient.*
 
 client.patch("https://jsonplaceholder.typicode.com/todos/{todoId}", todoId)
-  .json(changes)
-  .retrieveJson()
+    .json(changes)
+    .retrieveJson()
 ```
 <!-- @formatter:on -->