Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yjg30737 authored Jul 28, 2024
1 parent 83b0798 commit 369124c
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
<img src="https://user-images.githubusercontent.com/55078043/229002952-9afe57de-b0b6-400f-9628-b8e0044d3f7b.png" width="150px" height="150px"><br/><br/>

[![](https://dcbadge.vercel.app/api/server/cHekprskVE)](https://discord.gg/cHekprskVE)

[![](https://img.shields.io/badge/한국어-readme-green)](https://github.com/yjg30737/pyqt-openai/blob/main/README.kr.md)

</div>

Expand Down Expand Up @@ -62,11 +60,13 @@ And if you would like to support this project, you can click the button below to
* Import conversations from pyqt-openai, GPT
* Rename conversation
* "Favorite" feature
* Support JSON mode
* everything above is saved in an SQLite database file named conv.db. (File's name can be changed by yourself)
* Support controlling parameters(temperature, top_p, etc) just like openai playground
* Able to see the reason why stream is finished
* Support token count (only for non-streaming response)
* Support <b>prompt generator</b> (manageable, autosaved in database)
* Support <b>prompt generator</b> (manageable, autosaved in database)
* Support import & export prompt group as JSON
* Support <b>slash commands</b>
* Support beginning and ending part of the prompt
* You can <b>run this in background</b> application
Expand All @@ -77,11 +77,12 @@ And if you would like to support this project, you can click the button below to
* Support continue generation
* Notification when task completes
* You can copy and download the image directly as well. just hover the mouse cursor over the image.
* You can <b>fine-tune</b> openai with llama-index.
* You can <b>fine-tune</b> openai with llama-index and use it (support streaming response)
* Support text(*.txt), image(*.png, *.jpg) file uploading
* Support searching title and content in the conversation
* Support "find text" feature (match word, case-sensitive, regex, etc.)
* Support customizing feature (homepage, user and AI profile image)
* Support customizing feature (homepage, user and AI profile image, font settings)
* Support light/dark theme based on your system settings (Above Qt6 only)
* Full screen feature

## Supported Languages
Expand All @@ -96,9 +97,15 @@ And if you would like to support this project, you can click the button below to
* Hindi
* Arabic
* Japanese
* Bengali
* Urdu
* Indonesian
* Portuguese

If you have any additional languages you would like to add, please feel free to make a request by mail, issue, discord, etc at any time.

Also you can submit a pull request if you want to update any words naturally by modify "translations.json" in "lang" directory.

## Requirements
* qtpy - the package allowing you to write code that works with both PyQt5, PyQt6, PySide6
* PyQt5 >= 5.14 or PyQt6 (or PySide6 if you want)
Expand Down

0 comments on commit 369124c

Please sign in to comment.