Skip to content

Commit f0ddd41

Browse files
authored
Update README.md
1 parent 5cd1cad commit f0ddd41

File tree

1 file changed

+15
-40
lines changed

1 file changed

+15
-40
lines changed

README.md

Lines changed: 15 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -19,54 +19,29 @@
1919

2020
</div>
2121

22-
## What is DevChat?
22+
While tools like GitHub Copilot, Cursor, and Cline are making coding increasingly intelligent, and platforms like Dify, Flowise, and Coze enable drag-and-drop workflows, we developers still find ourselves wading through vast AI-less seas daily, wearied by the myriad tedious processes in development.
2323

24-
DevChat is an open-source workflow engine that enables developers to craft scripts for:
25-
- Engaging with users through a chat panel within their IDEs, facilitating the completion of development tasks.
26-
- Creating intelligent, automated workflows for these tasks, utilizing the full potential of various large language models (LLMs).
24+
While some complex customization demands of enterprises have turned tool adaptation into tar pits, hands-on enthusiasts are busily engaged in various personalized tasks.
25+
Every dev team has its own character and deserves tailored AI services, and implementing these shouldn’t be arduous.
2726

28-
DevChat combines the flexibility of script writing, the cutting-edge capabilities of latest AI models, and an enriched user experience through intuitive chat GUI.
29-
30-
## Why DevChat?
31-
32-
While numerous AI coding tools exist, many still struggle to adeptly handle nuanced scenarios inherent in bespoke development processes. For instance, your team might adhere to a specific coding format that existing products don't support configuration for. Or, you desire an automated workflow to run tests and, upon encountering an error, allow AI to attempt a fix, but only once to avoid likely subsequent failures. Such specific functionalities are often not fully realized in available products.
33-
34-
At its core, we believe that the creativity and productivity of developers are yet to be fully unleashed. Our aim with DevChat is to simplify the integration of AI in software development to the level of writing a script, thereby unlocking new possibilities for developers.
35-
36-
## Showcase
37-
38-
<a href="http://www.youtube.com/watch?feature=player_embedded&v=ucHdcEwp1E0" target="_blank">
39-
<img src="http://img.youtube.com/vi/ucHdcEwp1E0/mqdefault.jpg" alt="Watch the video" width="320" height="180" border="10" />
40-
</a>
41-
42-
Source code of the intelligent scripts in the above video:
43-
- Generate unit tests of a function: [/unit_tests](https://github.com/devchat-ai/workflows/tree/main/unit_tests).
44-
- Write a well-formatted commit message: [/commit](https://github.com/devchat-ai/workflows/tree/main/commit).
45-
- Automatically rename poorly-named local variables for improved readability: [/refactor.names](https://github.com/devchat-ai/workflows/tree/main/refactor/names).
27+
We’ve built the DevChat open-source community to help every developer effortlessly cross the last mile of AI productivity!
4628

4729
## Core Features
4830

49-
### IDE Chat Panels
50-
51-
- [Visual Studio Code extension](https://github.com/devchat-ai/devchat-vscode) from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=merico.devchat).
52-
53-
- [IntelliJ Platform plugin](https://github.com/devchat-ai/devchat-intellij) from [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23258-devchat).
54-
55-
### ChatMark
56-
57-
Documentation: https://docs.devchat.ai/chatmark-markdown-spec.
31+
### ❤️ Simplified Personalization: Create Custom Workflows with a Few Sentences
32+
- Say goodbye to the rigid and learning-intensive “drag-and-drop” workflow frameworks. With just a few sentences, you can easily generate intelligent workflows that assist or handle various tasks for you — whether it’s submitting a standardized GitLab MR, generating API automated API test cases, or having the AI provide progress updates via voice notifications.
33+
- Through the open-source community, we aim to build a rich collection of intelligent workflows, ranging from plugins that access rich IDE context to various autonomous agents, ensuring there’s always a “magical tool” that suits you.
5834

59-
### IDE Services
35+
### ❤️ Deep Understanding of Private Knowledge Through Knowledge Engineering
36+
- Integrated knowledge graph capabilities support diverse semantic queries, combining static pre-construction before queries with dynamic construction during queries to balance optimal effectiveness and performance.
37+
- Classify knowledge for specific scenarios to enhance AI generations.
38+
- For example, by analyzing all interfaces, parameters, and relationships in API documents, our AI autonomous testing tool can use multiple APIs to generate test cases, reducing exploratory steps and improving the quality of test scripts.
6039

6140
## Quick Start
6241

63-
For GUI, install our [IDE extension or plugin](https://docs.devchat.ai/quick-start/installation).
42+
- [Visual Studio Code extension](https://github.com/devchat-ai/devchat-vscode): Install from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=merico.devchat).
6443

65-
For CLI:
66-
- Install Python 3.8+ and [pip](https://pip.pypa.io/en/stable/installation/).
67-
- Install DevChat by running: `pip install devchat`.
68-
- Set your [OpenAI API Key](https://platform.openai.com/account/api-keys) by running `export OPENAI_API_KEY="[sk-...]"` (or DevChat access key).
69-
- To access help, use the command: `devchat --help` or `devchat prompt --help`.
44+
- [IntelliJ Platform plugin](https://github.com/devchat-ai/devchat-intellij): Install from [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/23258-devchat).
7045

7146
## Contributing
7247

@@ -76,9 +51,9 @@ For CLI:
7651
- Visual Studio Code extension: https://github.com/devchat-ai/devchat-vscode
7752
- IntelliJ Platform plugin: https://github.com/devchat-ai/devchat-intellij
7853

79-
- Issues and pull request are welcome: https://github.com/devchat-ai/devchat/issues
54+
- Issues and pull requests are welcome: https://github.com/devchat-ai/devchat/issues
8055

81-
- Join our [Discord](https://discord.gg/9t3yrbBUXD)!
56+
- Join our [Discord](https://discord.gg/JNyVGz8y)!
8257

8358
## What is Prompt-Centric Software Development (PCSD)?
8459

0 commit comments

Comments
 (0)