Skip to content

Commit a742bf7

Browse files
committed
Update readme
Signed-off-by: Rahul Krishna <[email protected]>
1 parent c08d304 commit a742bf7

File tree

3 files changed

+33
-8
lines changed

3 files changed

+33
-8
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,43 @@
1-
# Codellm-Devkit TypeScript SDK
1+
<picture>
2+
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/cldk-dark.png">
3+
<source media="(prefers-color-scheme: light)" srcset="docs/assets/cldk-light.png">
4+
<img alt="Logo">
5+
</picture>
26

3-
## 🚀 Overview
4-
Codellm-Devkit (CLDK) is a multilingual program analysis framework that bridges the gap between traditional static analysis tools and Large Language Models (LLMs) specialized for code (CodeLLMs). Codellm-Devkit allows developers to streamline the process of transforming raw code into actionable insights by providing a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs.
7+
<p align='center'>
8+
<a href="https://arxiv.org/abs/2410.13007">
9+
<img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=for-the-badge" />
10+
</a>
11+
<a href="https://opensource.org/licenses/Apache-2.0">
12+
<img src="https://img.shields.io/badge/License-Apache%202.0-green?style=for-the-badge" />
13+
</a>
14+
<a href="https://codellm-devkit.info">
15+
<img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=for-the-badge" />
16+
</a>
17+
<a href="https://www.npmjs.com/package/@cldk/cldk">
18+
<img src="https://img.shields.io/npm/v/@cldk/cldk?color=crimson&logo=npm&style=for-the-badge" />
19+
</a>
20+
<a href="https://discord.com/channels/1333486179667935403/1334150434348208208">
21+
<img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=for-the-badge"/>
22+
</a>
23+
</p>
524

6-
## 📦 Installation
25+
26+
**A framework that bridges the gap between traditional program analysis tools and Large Language Models (LLMs) specialized for code (CodeLLMs).**
27+
28+
### 🚀 Overview
29+
This is the TypeScript SDK for the Codellm-Devkit (CLDK). The SDK provides a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs. It allows developers to streamline the process of transforming raw code into actionable insights.
30+
31+
### 📦 Installation
732

833
To install the Codellm-Devkit TypeScript SDK, you can use npm or yarn. Run the following command in your terminal:
934

10-
### Using npm
35+
#### Using npm
1136
```bash
1237
npm install --save github:codellm-devkit/typescript-sdk#initial-sdk
1338
```
1439

15-
### Using yarn
40+
#### Using yarn
1641
```bash
1742
yarn add github:codellm-devkit/typescript-sdk#initial-sdk
1843
```
@@ -21,14 +46,14 @@ If you are on yarn v1
2146
yarn add codellm-devkit/typescript-sdk#initial-sdk
2247
```
2348

24-
### Using bun
49+
#### Using bun
2550
```bash
2651
bun add github:codellm-devkit/typescript-sdk#initial-sdk
2752
```
2853

2954
Then run `npm install`, `yarn install`, or `bun install` depending on your package manager.
3055

31-
## ⚙️ Basic Usage
56+
### ⚙️ Basic Usage
3257

3358
Here’s how to use CLDK to analyze a Java project and access key analysis artifacts:
3459

docs/assets/cldk-dark.png

348 KB
Loading

docs/assets/cldk-light.png

348 KB
Loading

0 commit comments

Comments
 (0)