Merge branch 'main' into feature/add-agent-status

README.md

@@ -6,4 +6,31 @@
 
 # AIGENTIC
 
-Framework to configure AI agents
+Framework to configure and run AI agents
+
+
+## How to use
+
+To build an agent which uses OpenAI as model provider with local (non http tools) use the following dependencies:
+
+```
+implementation("community.flock.aigentic:core:0.0.4-SNAPSHOT")
+implementation("community.flock.aigentic:openai:0.0.4-SNAPSHOT")
+// CIO is for JVM, Android, Native. For other platforms pick the correct engine: https://ktor.io/docs/client-engines.html#platforms
+implementation(libs.ktor.client.cio)
+```
+
+## Example agent
+
+[AdministrativeAgentExample](src/example/src/commonMain/kotlin/community/flock/aigentic/example/AdministrativeAgentExample.kt)
+
+### How to use snapshots
+
+In order to use SNAPSHOT versions of Aigentic please make sure both maven central and the Sonatype snapshot repository are configured:
+
+```
+repositories {
+    mavenCentral()
+    maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") }
+}
+```

gradle/wrapper/gradle-wrapper.properties

@@ -4,3 +4,4 @@ distributionUrl=https\://services.gradle.org/distributions/gradle-8.1-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
+org.gradle.unsafe.configuration-cache=false

src/core/build.gradle.kts

@@ -19,6 +19,7 @@ kotlin {
                 api(libs.coroutines.core)
                 implementation(libs.serialization.json)
                 implementation(libs.kotlinx.datetime)
+                api(libs.serialization.json)
             }
         }
         val commonTest by getting {

src/example/build.gradle.kts

@@ -13,16 +13,15 @@ kotlin {
     sourceSets {
         val commonMain by getting {
             dependencies {
-                api(libs.coroutines.core)
-                implementation(libs.serialization.json) // FIXME temporary needed for tool Handler arguments
                 implementation(project(":src:core"))
                 implementation(project(":src:providers:openai"))
             }
         }
 
         val jvmMain by getting {
             dependencies {
-                implementation(libs.ktor.client.okhttp)
+                // CIO is for JVM, Android, Native. For other platforms pick the correct engine: https://ktor.io/docs/client-engines.html#platforms
+                implementation(libs.ktor.client.cio)
             }
         }
     }