Skip to content

Commit

Permalink
Update readme (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
basicthinker committed May 19, 2023
1 parent 1a54495 commit e700607
Showing 1 changed file with 40 additions and 21 deletions.
61 changes: 40 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,39 +19,52 @@

The DevChat core library and CLI.

:point_right: Better 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 UI :clap:
:point_right: 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 :clap:



https://github.com/covespace/devchat/assets/592493/76e997fe-33a3-4fee-8f67-5523df90316e



***

## What is DevChat?

The way developers chat and work with AI.
DevChat is an open-source tool that helps you write prompts to generate code and documentation.
It is _not_ limited to performing predefined operations on short code snippets.

DevChat is the way developers interact and collaborate with AI.

:speech_balloon: Write prompts, _not_ code.
:speech_balloon: Build the future with prompts, _not_ code.

## Why DevChat?

- To let AI write code, DevChat helps you bring **the right context** to AI.
- To enable AI to write code, DevChat assists you in providing **the right context** for AI.

Chat history. Code. Files. A directory tree. `git diff --cached` or the output of any command.
Chat history, code, files, directory trees, `git diff --cached`, or the output of any command.

- To apply AI-generated code, DevChat facilitate your **actions to take**.
<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**.

Show diff. Copy or insert. Commit & sync or export to docs, wiki, etc.
View diffs, copy or insert, commit & sync, or export to documentation, wikis, and more.

- To drive AI to work, define **your own workflows** with DevChat.
<img width="500" alt="image" src="https://github.com/covespace/devchat-vscode/assets/592493/bcccbf20-0d30-46f4-b19f-5f532c1caf85">

Prompt templates. Iterative calls to AI. Program operations.
- To guide AI in your work, define **your own workflows** with DevChat.

Prompt templates, iterative calls to AI, and program operations.

- To meet your personality, customize **your own experiences** with DevChat.
- To suit your preferences, customize **your own experiences** with DevChat.

Open source. No wait on opaque feature schedule. GPT-4 today and more models tomorrow.
Open-source, no waiting for opaque feature schedules. Access GPT-4 today and more models in the future.

## What is Prompt-Centric Software Development (PSSD)?

- The traditional code-centric paradigm is changing.
- The traditional code-centric paradigm is evolving.

- Write prompts to create code. Turn prompts to everything.
- Write prompts to create code. Transform prompts into everything.

- It is DevPromptOps

Expand All @@ -62,15 +75,21 @@ The way developers chat and work with AI.

## Quick Start

- Install by: `pip install devchat`
- DevChat only works in a Git repository, so enter a Git directory.
- Check out help: `devchat --help` and `devchat prompt --help`
- 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`

## Community

- Join our [Discord](https://discord.gg/9t3yrbBUXD)!

- Participate in [discussions](https://github.com/covespace/devchat/discussions)!

## Roadmap

- [ ] Topic management.
- [ ] Better application of code diff.
- [ ] Framework to define workflows.
- [ ] Interaction with external dev tools.
- [x] Implement code diff application.
- [ ] Improve code diff application using code change instructions.
- [ ] Develop a framework for defining workflows.
- [ ] Implement topic management.
- [ ] Enable interaction with external development tools.
- [ ] Introduce more selective workflows.

0 comments on commit e700607

Please sign in to comment.