update readme

2023-05-21 17:28:51 +08:00
parent cfc7fcdf87
commit 39222f037d
2 changed files with 159 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,80 @@
-# RWKV-Runner
+<p align="center">
+    <img src="https://github.com/josStorer/RWKV-Runner/assets/13366013/d24834b0-265d-45f5-93c0-fac1e19562af">
+</p>

-In development
+<h1 align="center">RWKV Runner</h1>
+
+<div align="center">
+
+This project aims to eliminate the barriers of using large language models by automating everything for you. All you need is a lightweight executable program of just a few megabytes. Additionally, this project provides an interface compatible with the OpenAI API, which means that every ChatGPT client is an RWKV client.
+
+[![license][license-image]][license-url]
+[![release][release-image]][release-url]
+
+English | [简体中文](README_ZH.md)
+
+[Preview](#Preview) | [Download][download-url]
+
+[license-image]: http://img.shields.io/badge/license-MIT-blue.svg
+
+[license-url]: https://github.com/josStorer/RWKV-Runner/blob/master/LICENSE
+
+[release-image]: https://img.shields.io/github/release/josStorer/RWKV-Runner.svg
+
+[release-url]: https://github.com/josStorer/RWKV-Runner/releases/latest
+
+[download-url]: https://github.com/josStorer/RWKV-Runner/releases/download/v1.0.0/RWKV-Runner_windows_x64.exe
+
+</div>
+
+## Features
+
+- RWKV model management and one-click startup
+- Fully compatible with the OpenAI API, making every ChatGPT client an RWKV client
+- Automatic dependency installation, requiring only a lightweight executable program
+- User-friendly chat interaction interface included
+- Easy-to-understand and operate parameter configuration
+- Built-in model conversion tool
+- Built-in download management and remote model inspection
+- Multilingual localization
+- Theme switching
+- Automatic updates
+
+## Todo
+
+- Model training functionality
+- CUDA operator int8 acceleration
+- macOS support
+- Linux support
+
+## Related Repositories:
+
+- RWKV-4-Raven: https://huggingface.co/BlinkDL/rwkv-4-raven/tree/main
+- ChatRWKV: https://github.com/BlinkDL/ChatRWKV
+- RWKV-LM: https://github.com/BlinkDL/RWKV-LM
+
+## Preview
+
+### Homepage
+
+![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/9d25380a-a17b-443f-b823-86c754ebebf0)
+
+### Chat
+
+![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/0e66d5fa-f34a-409f-9cd4-d880815733f3)
+
+### Configuration
+
+![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/ad9921fc-7248-40a3-9e18-03445b86e4bf)
+
+### Model Management
+
+![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/7c36f15f-3e77-49cd-a16d-99a29f870bdf)
+
+### Download Management
+
+![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/32fde30b-11dd-43b9-9667-ad6975be2106)
+
+### Settings
+
+![image](https://github.com/josStorer/RWKV-Runner/assets/13366013/e8a0f746-9da7-48e3-b3fc-e1453ac50de2)