diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..77b7509 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) diff --git a/README.md b/README.md index d8be803..95a75f4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install chatGPT-web with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chatgpt-web) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *This package allows you to install chatGPT-web quickly and simply on a YunoHost server. -If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* +> *This package allows you to install chatGPT-web quickly and simply on a YunoHost server.* +> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.* ## Overview @@ -31,9 +31,9 @@ ChatGPT-web is a simple one-page web interface to the OpenAI ChatGPT API. To use - Code: ChatGPT-web recognizes and highlights code blocks and allows you to copy them with one click. -**Shipped version:** 2024.01.29~ynh1 +**Shipped version:** 2024.04.08~ynh1 -**Demo:** https://niek.github.io/chatgpt-web/ +**Demo:** ## Screenshots @@ -45,18 +45,18 @@ ChatGPT-web is a simple one-page web interface to the OpenAI ChatGPT API. To use ## Documentation and resources -* Official app website: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug or sudo yunohost app upgrade chatgpt-web -u https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..1cbf960 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,65 @@ + + +# chatGPT-web YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/chatgpt-web.svg)](https://dash.yunohost.org/appci/app/chatgpt-web) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/chatgpt-web.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/chatgpt-web.maintain.svg) + +[![Instalatu chatGPT-web YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chatgpt-web) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek chatGPT-web YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +ChatGPT-web is a simple one-page web interface to the OpenAI ChatGPT API. To use it, you need to register for an OpenAI API key first. All messages are stored in your browser's local storage, so everything is private. You can also close the browser tab and come back later to continue the conversation. + +### Features + +- Private: All chats and messages are stored in your browser's local storage, so everything is private. +- Customizable: You can customize the prompt, the temperature, and other model settings. Multiple models (including GTP-4) are supported. +- Cheaper: ChatGPT-web uses the commercial OpenAI API, so it's much cheaper than a ChatGPT Plus subscription. +- Fast: ChatGPT-web is a single-page web app, so it's fast and responsive. +- Mobile-friendly: ChatGPT-web is mobile-friendly, so you can use it on your phone. +- Voice input: ChatGPT-web supports voice input, so you can talk to ChatGPT. It will also talk back to you. +- Pre-selected prompts: ChatGPT-web comes with a list of pre-selected prompts, so you can get started quickly. +- Export: ChatGPT-web can export chats as a Markdown file, so you can share them with others. +- Code: ChatGPT-web recognizes and highlights code blocks and allows you to copy them with one click. + + +**Paketatutako bertsioa:** 2024.04.08~ynh1 + +**Demoa:** + +## Pantaila-argazkiak + +![chatGPT-web(r)en pantaila-argazkia](./doc/screenshots/screenshot.png) + +## :red_circle: Ezaugarri zalantzagarriak + +- **Libreak ez diren sareko zerbitzuak**: Librea ez den sare-zerbitzu bat sustatzen du edo horren mende dago erabat. + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug +edo +sudo yunohost app upgrade chatgpt-web -u https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 05ff373..085791f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # chatGPT-web pour YunoHost @@ -9,44 +9,44 @@ It shall NOT be edited by hand. [![Installer chatGPT-web avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chatgpt-web) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer chatGPT-web rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* +> *Ce package vous permet d’installer chatGPT-web rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble ChatGPT-web est une simple interface Web d'une page pour l'API OpenAI ChatGPT. Pour l'utiliser, vous devez d'abord vous inscrire à une clé API OpenAI. Tous les messages sont stockés dans le stockage local de votre navigateur, donc tout est privé. Vous pouvez également fermer l'onglet du navigateur et revenir plus tard pour poursuivre la conversation. -**Version incluse :** 2024.01.29~ynh1 +**Version incluse :** 2024.04.08~ynh1 -**Démo :** https://niek.github.io/chatgpt-web/ +**Démo :** ## Captures d’écran ![Capture d’écran de chatGPT-web](./doc/screenshots/screenshot.png) -## :red_circle: Fonctions indésirables +## :red_circle: Anti-fonctionnalités -- **Non-free Network Services**: Promotes or depends entirely on a non-free network service. +- **Services réseau non libres **: Promeut ou utilise des services réseau non libres. ## Documentations et ressources -* Site officiel de l’app : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug ou sudo yunohost app upgrade chatgpt-web -u https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..b6cc1b1 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,65 @@ + + +# chatGPT-web para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/chatgpt-web.svg)](https://dash.yunohost.org/appci/app/chatgpt-web) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/chatgpt-web.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/chatgpt-web.maintain.svg) + +[![Instalar chatGPT-web con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chatgpt-web) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar chatGPT-web de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +ChatGPT-web is a simple one-page web interface to the OpenAI ChatGPT API. To use it, you need to register for an OpenAI API key first. All messages are stored in your browser's local storage, so everything is private. You can also close the browser tab and come back later to continue the conversation. + +### Features + +- Private: All chats and messages are stored in your browser's local storage, so everything is private. +- Customizable: You can customize the prompt, the temperature, and other model settings. Multiple models (including GTP-4) are supported. +- Cheaper: ChatGPT-web uses the commercial OpenAI API, so it's much cheaper than a ChatGPT Plus subscription. +- Fast: ChatGPT-web is a single-page web app, so it's fast and responsive. +- Mobile-friendly: ChatGPT-web is mobile-friendly, so you can use it on your phone. +- Voice input: ChatGPT-web supports voice input, so you can talk to ChatGPT. It will also talk back to you. +- Pre-selected prompts: ChatGPT-web comes with a list of pre-selected prompts, so you can get started quickly. +- Export: ChatGPT-web can export chats as a Markdown file, so you can share them with others. +- Code: ChatGPT-web recognizes and highlights code blocks and allows you to copy them with one click. + + +**Versión proporcionada:** 2024.04.08~ynh1 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de chatGPT-web](./doc/screenshots/screenshot.png) + +## :red_circle: Caraterísticas cuestionables + +- **Non-free Network Services**: Promotes or depends entirely on a non-free network service. + +## Documentación e recursos + +- Web oficial da app: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug +ou +sudo yunohost app upgrade chatgpt-web -u https://github.com/YunoHost-Apps/chatgpt-web_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:**