docs: add readme badges (#111)

* fix: codecov Signed-off-by: Yuhang Shi <[email protected]> * feat: readme Signed-off-by: Yuhang Shi <[email protected]> * feat: bump dependencies Signed-off-by: Yuhang Shi <[email protected]> --------- Signed-off-by: Yuhang Shi <[email protected]>
pleisto · Oct 25, 2023 · d0221af · d0221af
1 parent f374168
commit d0221af
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 32 deletions.
diff --git a/.github/workflows/kotlin-ci.yml b/.github/workflows/kotlin-ci.yml
@@ -63,6 +63,9 @@ jobs:
         uses: codecov/codecov-action@v3
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          flags: kotlin
+          fail_ci_if_error: true
+          verbose: true
 
   tests:
     name: kotlin-ci-test

diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
 # Flappy Monorepo
 
+<div align="center">
+
+[![License](https://img.shields.io/github/license/pleisto/flappy.svg)](https://raw.githubusercontent.com/pleisto/flappy/main/LICENSE)
+
+</div>
+
+
 > :warning: **This project is still under development.** We're working hard to release the first version of Flappy as soon as possible. Stay tuned! Documentation and code examples will be available soon.
 
 This monorepo gathers all the Flappy libraries, each implemented in a different programming language. Flappy is a library developed to streamline the creation of AI applications and agents that use Large Language Models (LLMs).
@@ -14,6 +21,18 @@ Flappy is a production-ready Language Language Model (LLM) Application/Agent SDK
 - **Production-Ready**: Beyond research, Flappy is a robust SDK that balances cost-efficiency and sandbox security to provide a stable platform for commercial environments.
 - **Language-Agnostic**: Flappy integrates seamlessly with any programming language, eliminating the need for Python unless explicitly required by your application.
 
+## SDK
+
+|   | Source | Package | Documentation  | CI Status | Coverage |
+| - | ------ | ------- | -------------- | --------- | -------- |
+| <img src="./assets/languages/nodejs.png" width=24px height=24px> | [**NodeJS**][NodeJS integration] | [![NPM version](https://img.shields.io/npm/v/%40pleisto/node-flappy/next.svg)](https://npmjs.org/package/@pleisto/node-flappy) | [![Documentation](https://img.shields.io/badge/documentation-documentation.svg)](https://flappy.pleisto.com) | [![CI](https://img.shields.io/github/actions/workflow/status/pleisto/flappy/nodejs-ci.yml.svg)](https://github.com/pleisto/flappy/actions/workflows/nodejs-ci.yml) | |
+| <img src="./assets/languages/java.svg" width=24px height=24px>    | [**Java**][Kotlin integration]    | [![Maven metadata URL](https://img.shields.io/maven-metadata/v.svg?metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fpleisto%2Fflappy%2Fmaven-metadata.xml&color=blue)](https://central.sonatype.com/artifact/com.pleisto/flappy) | [![Documentation](https://img.shields.io/badge/documentation-documentation.svg)](https://javadoc.io/doc/com.pleisto/flappy) | [![CI](https://img.shields.io/github/actions/workflow/status/pleisto/flappy/kotlin-ci.yml.svg)](https://github.com/pleisto/flappy/actions/workflows/kotlin-ci.yml) | [![codecov](https://codecov.io/gh/pleisto/flappy/graph/badge.svg?token=8C94YY3KBD)](https://codecov.io/gh/pleisto/flappy)
+| <img src="./assets/languages/csharp.svg" width=24px height=24px>     | [**C#**][C# integration]         | [![NuGet version (Pleisto.Flappy)](https://img.shields.io/nuget/v/Pleisto.Flappy.svg?style=flat-square)](https://www.nuget.org/packages/Pleisto.Flappy/) | [![Documentation](https://img.shields.io/badge/documentation-documentation.svg)](https://flappy.pleisto.com) | [![CI](https://img.shields.io/github/actions/workflow/status/pleisto/flappy/csharp-ci.yml.svg)](https://github.com/pleisto/flappy/actions/workflows/csharp-ci.yml) | |
+
+[nodejs integration]: ./packages/nodejs/README.md
+[kotlin integration]: ./packages/kotlin/README.md
+[c# integration]: ./packages/csharp/README.md
+
 ## Core Components
 
 ### Agent Functions

diff --git a/assets/languages/csharp.svg b/assets/languages/csharp.svg
diff --git a/assets/languages/java.svg b/assets/languages/java.svg
diff --git a/assets/languages/nodejs.png b/assets/languages/nodejs.png
diff --git a/packages/csharp/README.md b/packages/csharp/README.md
@@ -2,7 +2,7 @@
 
 [![License](https://img.shields.io/github/license/pleisto/flappy)](../../LICENSE)
 [![NuGet version (Pleisto.Flappy)](https://img.shields.io/nuget/v/Pleisto.Flappy.svg?style=flat-square)](https://www.nuget.org/packages/Pleisto.Flappy/)
-[![NUnit test](https://github.com/pleisto/flappy/actions/workflows/csharp-ci.yml/badge.svg)](https://github.com/pleisto/flappy/actions/workflows/csharp-ci.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/pleisto/flappy/csharp-ci.yml.svg)](https://github.com/pleisto/flappy/actions/workflows/csharp-ci.yml)
 
 This package is the CSharp version of the flappy implementation.
 

diff --git a/packages/kotlin/flappy/build.gradle.kts b/packages/kotlin/flappy/build.gradle.kts
@@ -69,7 +69,7 @@ dependencies {
   implementation("io.ktor:ktor-client-okhttp:2.3.5")
   implementation("com.theokanning.openai-gpt3-java:service:0.16.1")
   implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.15.3")
-  implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.14.2")
+  implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.15.3")
   implementation("io.github.cdimascio:dotenv-kotlin:6.4.1")
   implementation("com.pleisto:flappy-java-bindings:0.0.8")
   implementation("com.pleisto:flappy-java-bindings:0.0.8:${osdetector.classifier}")
@@ -144,7 +144,7 @@ tasks.test {
 }
 
 jacoco {
-  toolVersion = "0.8.10"
+  toolVersion = "0.8.11"
 }
 
 tasks.jacocoTestReport {

diff --git a/packages/kotlin/flappy/src/main/kotlin/flappy/Coroutine.kt b/packages/kotlin/flappy/src/main/kotlin/flappy/Coroutine.kt
diff --git a/packages/nodejs/README.md b/packages/nodejs/README.md
@@ -4,7 +4,7 @@
 
 [![License](https://img.shields.io/github/license/pleisto/flappy.svg)](https://raw.githubusercontent.com/pleisto/flappy/main/LICENSE)
 [![CI](https://img.shields.io/github/actions/workflow/status/pleisto/flappy/nodejs-ci.yml.svg)](https://github.com/pleisto/flappy/actions/workflows/nodejs-ci.yml)
-[![NPM version](https://img.shields.io/npm/v/@pleisto/node-flappy.svg)](https://npmjs.org/package/@pleisto/node-flappy)
+[![NPM version](https://img.shields.io/npm/v/%40pleisto/node-flappy/next.svg)](https://npmjs.org/package/@pleisto/node-flappy)
 
 This package is about the Node.js version of the implementation which is written in TypeScript.