From d53a6d24cc3b375a7f48b3ccdb6d129f29a9e473 Mon Sep 17 00:00:00 2001 From: Jinglei Ren Date: Sun, 21 May 2023 18:40:05 +0800 Subject: [PATCH] Replace video with gits in README.md --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 322a78e3..7dab801e 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,6 @@ The DevChat core library and CLI. 👉 For a better experience, check out our [Visual Studio Code extension](https://github.com/covespace/devchat-vscode) on [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=merico.devchat)! Install and enjoy the enhanced UI 👏 -https://github.com/covespace/devchat/assets/592493/76e997fe-33a3-4fee-8f67-5523df90316e - *** ## What is DevChat? @@ -38,19 +36,21 @@ DevChat is the way developers interact and collaborate with AI. - To enable AI to write code, DevChat assists you in providing **the right context** for AI. + ![20230519-231038-00 00 00 000-00 00 20 989](https://github.com/covespace/devchat-vscode/assets/592493/cfb96c7f-bd45-4573-810e-17148aac79d1) + Chat history, code, files, directory trees, `git diff --cached`, or the output of any command. - image - - To apply AI-generated code, DevChat streamlines your **actions to take**. - View diffs, copy or insert, commit & sync, or export to documentation, wikis, and more. + ![20230519-231038-00 00 24 989-00 00 44 688](https://github.com/covespace/devchat-vscode/assets/592493/2a0c4acf-6801-409c-bb18-ac75bae96938) - image + View diffs, copy or insert, commit & sync, or export to documentation, wikis, and more. - To guide AI in your work, define **your own workflows** with DevChat. - Prompt templates, iterative calls to AI, and program operations. + ![20230519-231038-00 00 45 034-00 01 00 000](https://github.com/covespace/devchat-vscode/assets/592493/5a72e43f-0ed9-446a-81be-3e5f00009961) + + More prompt templates, iterative calls to AI, and program operations. - To suit your preferences, customize **your own experiences** with DevChat. @@ -65,16 +65,19 @@ DevChat is the way developers interact and collaborate with AI. - It is DevPromptOps image - + (This work is licensed by devchat.ai under a Creative Commons Attribution-ShareAlike 4.0 International License.) *** ## Quick Start -- Install DevChat by running: `pip install devchat` +For UI, install the [Visual Studio Code extension](https://github.com/covespace/devchat-vscode) from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=merico.devchat). + +For CLI: +- Install DevChat by running: `pip install devchat`. - Make sure you are in a Git repository, as DevChat only works within one. -- To access help, use the commands: `devchat --help` and `devchat prompt --help` +- To access help, use the commands: `devchat --help` and `devchat prompt --help`. ## Community @@ -90,3 +93,10 @@ DevChat is the way developers interact and collaborate with AI. - [ ] Implement topic management. - [ ] Enable interaction with external development tools. - [ ] Introduce more selective workflows. + +## Contact Information + +hello@merico.dev + +We are creators of [Apache DevLake](https://devlake.apache.org/). +