README for v0.6

README.md

@@ -1,34 +1,34 @@
-![](./public/logo_full_blue.png)
+![](./public/logo_full_blue.jpg)
 
-# HostedGPT
+# HostedGPT v0.6
 
-HostedGPT is a free, open-source chat interface in the style of ChatGPT. You can run it on any server or even your own computer. It's a Ruby on Rails app. Just bring your own OpenAI API key. All the core functionality of ChatGPT is already working (e.g. GPT-3.5 and GPT-4, starting new conversations, streaming responses, asking about attached images, etc). The main thing missing is the mobile app but that's coming soon and it already works well as a mobile web app.
+HostedGPT is a free, open-source alternative to ChatGPT. It's a Ruby on Rails app so you can run it on any server or even your own computer. Just bring your own OpenAI API key.
 
-Plus, this app has extra features. You can use Anthropic's Claude 3 in the same interface as GPT-4. You can also switch assistants in the middle of a conversation.
+This app is designed to be incredibly easy for ChatGPT users to switch. All the features you expect are here plus it supports Claude 3 and GPT-4 in a single app. You can also switch assistants in the middle of a conversation!
 
-This project is actively looking for contributors to help make it great. The goal is for *every* feature that exists in ChatGPT to exist in this app along with many improvements.
+This project is led by an experienced rails developer, but I'm actively looking for contributors to help!
 
-### Some favorite features of HostedGPT
+### Top features of HostedGPT
 
-* **Enjoy chat history, but without your private conversations being used for training!**
+* **Your private conversations are not being used for training!**
+ChatGPT uses your private conversations history to train its models. [OpenAI disclosed this in this article](https://help.openai.com/en/articles/7730893-data-controls-faq), and if you disable it then you lose all your conversation history!
+* **Use GPT-4 and Claude 3 without two $20 / month subscriptions, you don't even need a single $20 subscription!** You only pay as much as you use. HostedGPT costs nothing so you just pay for your GPT-4 and Claude 3 API usage.
+* **A very polished interface with great mobile support** You can "install" on your mobile phone by opening your instance of HostedGPT in your Safari browser, tapping the Share icon, and then selecting "Add to Home Screen".
+* **You will never hit the '*You've reached the current usage cap*' errors**.
 
-  Did you know that all your private, personal past conversations in the left sidebar are allowed to be used for OpenAI training? [Disclosed in this OpenAI article.](https://help.openai.com/en/articles/7730893-data-controls-faq) HostedGPT excludes your history from OpenAI training.
-* **Don't commit yourself to $20 per month when you may not use ChatGPT a lot.** You only pay as much as you use!
-* **You will never hit the '*You've reached the current usage cap for GPT-4*'.** You pay per mesage based on the API rates so you can keep using it as much as you want.
-* **Use Claude 3 and soon Gemini in the same app as GPT-4**. You won't have your conversation history split across three apps and have different interfaces for each one.
 
-
-### Watch a demo of the app:
+### Watch a short demo
 
 [![](https://p425.p0.n0.cdn.zight.com/items/qGubwRKr/c4a119a9-254d-454a-b602-610b428ee769.jpg)](https://www.youtube.com/watch?v=m1UfKGWEhFs)
 
 
 # Table of Contents
 
-- [Set Up Live App](#set-up-live-app)
-- [Contribute as a Developer](#contribute-as-a-developer)
+- [Setup the app](#setup-the-app)
+- [Contribute as a developer](#contribute-as-a-developer)
+- [Changelog](#changelog)
 
-# Set Up Live App
+# Setup the app
 
 You can deploy a full version of HostedGPT to the hosting service, Render, for free. This free app works for 90 days and then the database will stop working. You will need to upgrade to a paid version of the database which is $7 / month. Alternatively, you can also run it off your local computer. Jump down to the [Developer Instructions](#contribute-as-a-developer) if you want to run it locally.
 
@@ -46,25 +46,25 @@ You can deploy a full version of HostedGPT to the hosting service, Render, for f
 
 **NOTE: After 15 minutes of not using the app your Render server will pause. Next time you visit the first request will auto-resume the server, but this resume is slow. If this annoys you, upgrade Render for $7 per month:**
 
-1. Go to your [Render Dashboard](https://dashboard.render.com/)
+1. To upgrade, go to your [Render Dashboard](https://dashboard.render.com/)
 2. Click "HostedGPT" or whatever you named your Web Service
 3. Click "Upgrade" and select $7 per month
 
 ## Troubleshooting Render
 
 1. If you encountered an error while waiting for the services to be deployed on Render, click **Dashboard** at the top of the Render screen and click the Service that failed.
 2. It should take you to the Events section and the top event should explain the error. It will probably contain a link to click to the **deploy logs**
-3. Scroll back up through the logs and find any instances of errors. [Open a new Issue for us](https://github.com/allyourbot/hostedgpt/issues/new) and share details.
+3. Scroll back up through the logs and find any instances of errors. [Start a new discussion](https://github.com/allyourbot/hostedgpt/discussions/new?category=general) and share details.
 4. When you are ready to try Render again, it's best to do the following:
 5. First, ensure your repo is caught up. Open your fork in github, click the Sync Fork button so that any bug fixes are pulled in.
 6. Second, in Render navigate to the Dashboard, Bluebrint, and Env Groups and delete any details associated with **hostedgpt**
 7. Now you can go back to your repo and click **Deploy to Render**
 
-# Contribute as a Developer
+# Contribute as a developer
 
-We welcome contributors! After you get your developoment environment setup, review the list of Issues. We organize the issues into Milestones and are currently working on v0.8. [View 0.8 Milestone](https://github.com/allyourbot/hostedgpt/milestone/5). Look for any issues tagged with **Good first issue** and add a comment so we know you're working on it.
+We welcome contributors! After you get your developoment environment setup, review the list of Issues. We organize the issues into Milestones and are currently working on v0.7. [View 0.7 Milestone](https://github.com/allyourbot/hostedgpt/milestone/6). Look for any issues tagged with **Good first issue** and add a comment so we know you're working on it.
 
-## Setting up Development
+## Setting up development
 
 The easiest way to get up and running is to use the provided docker compose workflow. The only things you need installed on your computer are Docker and Git.
 
@@ -73,7 +73,7 @@ The easiest way to get up and running is to use the provided docker compose work
 3. `cd` into your clone.
 4. Run `docker compose up` to start the app.
 5. Open [http://localhost:3000](http://localhost:3000) and register as a new user.
-6. Run tests: `docker compose run base rails test`
+6. Run tests: `docker compose run base rails test` The app has comprehensive test coverage.
 7. Open the rails console: `docker compose run base rails console`
 8. Run a psql console: `docker compose run base psql`
 
@@ -87,7 +87,35 @@ HostedGPT requires these services to be running:
 
 1. `cd` into your local repository clone
 2. `asdf install` to install the correct ruby version
-4. `bundle install` to install ruby gems
-5. `bin/rails db:setup` < Note: This will load the sample fixture data into your database
-6. `bin/dev` < Starts up all the services
-5. Open [http://localhost:3000](http://localhost:3000) and register as a new user.
+3. `bundle install` to install ruby gems
+4. `bin/rails db:setup` < Note: This will load the sample fixture data into your database
+5. `bin/dev` < Starts up all the services
+6. Open [http://localhost:3000](http://localhost:3000) and register as a new user
+7. `bin/rails test` and `bin/rails test:system` to run the comprehensive tests
+
+# Changelog
+
+(Top features being developed for v0.7: voice support, Gemini Pro, pin conversations)
+
+v0.6 - Released on 4/26/2024
+
+* Abort a long AI reply by clicking stop or simply "interrupting" it with a new question
+* Edit your messages and view previous versions with the left & right arrows
+* Support PWA (progressive web app) install for mobile phones (open in Safari, tap share then "Add to Home")
+* Show a helpful error messages when the API responds with an error
+* Re-generate an AI responses and even switch to a different assistant
+* Copy-to-clipboard button (and keyboard shortcut) for messages and markdown sections
+* Markdown is properly rendered in AI responses (and your own chats)
+* Include images in your messages (click icon, drag & drop, or copy & paste into message)
+
+v0.5 - Released on 2/14/2024
+
+* Anthropic's Claude 3 models can be used alongside GPT-4 and GPT-3
+* Dark mode theme is now supported (it switches automatically with your OS)
+* Full keyboard shortcuts have been added (press ? to see them)
+* AI assistants can be given custom instructions (under Profile > Settings)
+* Delete conversations
+* Ability to edit conversation title
+* Conversations are automatically titled
+* Sidebar can be closed
+* AI responses stream in