Skip to content

Commit

Permalink
Replace video with gits in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
basicthinker committed May 21, 2023
1 parent 3c806bf commit d53a6d2
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand All @@ -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.

<img width="500" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/415df4aa-66d6-46e4-a30d-8bba6277028c">

- 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)

<img width="500" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/bcccbf20-0d30-46f4-b19f-5f532c1caf85">
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.

Expand All @@ -65,16 +65,19 @@ DevChat is the way developers interact and collaborate with AI.
- It is DevPromptOps

<img width="500" alt="image" src="https://github.com/covespace/devchat/assets/592493/e8e1215b-53b0-4473-ab00-0665d33f204a">

<sub>(This work is licensed by devchat.ai under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.)</sub>

***

## 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

Expand All @@ -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/).

0 comments on commit d53a6d2

Please sign in to comment.