add README

README.md

@@ -0,0 +1,220 @@
+<a name="readme-top"></a>
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+## Built With
+
+[![Svelte][svelte-shield]][svelte-url] [![SvelteKit][sveltekit-shield]][sveltekit-url] [![OpenAI][openai-shield]][openai-url]
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://slickgpt.vercel.app/">
+    <img src="static/logo-slickgpt.svg" alt="Logo" height="160">
+  </a>
+
+  <h3 align="center">SlickGPT</h3>
+
+  <p align="center">
+    An awesome ChatGPT Client - with Superpowers!
+    <br />
+    <a href="https://slickgpt.vercel.app/"><strong>Try for yourself »</strong></a>
+    <br />
+    <br />
+    <a href="https://platform.openai.com/account/api-keys">Get your API key</a>
+    ·
+    <a href="https://github.com/ShipBit/slickgpt/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/ShipBit/slickgpt/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about-the-project">About The Project</a></li>
+    <li><a href="#features">Features</a></li>
+    <li><a href="#comparison-with-chatgpt">Comparison with ChatGPT</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+## About the project
+
+![SlickGPT][slickgpt-screenshot]
+
+SlickGPT allows you to run your own local ChatGPT instance, host it yourself or just use our instance if you like. Users bring their own OpenAI API keys. SlickGPT offers them a very fancy user interface with a rich feature set like managing a local chat history (in the localStorage), a userless "Share" function for chats, a prominent context editor, and token cost calculation and distribution.
+
+## Feature Overview
+
+- **Fancy User Interface** <br> Interact with an elegant and cleanUI that makes chatting fun and explains a lot of the heavy stuff to users.
+- **Mobile first and fully responsive** <br> SlickGPT is always at your hand. Literally, on your phone.
+- **Local History** <br> Your chat history is stored in localStorage and never leaves your machine (until you actively decide to share chats).
+- **Share Chats** <br> Generate shareable links for your chats with 3 clicks to collaborate and brainstorm ideas with your team or friends. Without any authentication.
+- **Set Context** <br> Provide your own context to guide the AI model while giving responses, ensuring relevant and focused outcomes.
+- **Cost Calculation** <br> Keep track of and control your API usage costs with an in-built token cost calculator for your chats.
+- **Full Configuration Power** <br> Customize OpenAI model settings to tailor the experience to your liking.
+- **No Registration or Login required** <br> Create and even share chats without the need for a login or registration - Simple, fast, and efficient.
+- **Use your own API Key** <br> Keep your API calls private and secure by using your own OpenAI API key.
+- **Host Yourself / Run Everywhere** <br> Run the instance locally on your machine or host it on your preferred cloud provider.
+
+<p align="right">[ <a href="#readme-top">back to top</a> ]</p>
+
+## In more detail
+
+### Local chat history
+
+Your chat history is stored in the localStorage of your browser and never leaves your machine (unless you actively decide to share a chat.
+
+<a href="static/docu/history.png">
+  <img src="static/docu/history.png" alt="History of chats" height="300">
+</a>
+
+### Share Chats
+
+Share chats with 3 clicks to collaborate and brainstorm ideas with your team or friends. No authentication or registration necessary. You can also unshare or update shared chats later. Recipients can import shared chats with a single click and continue your conversation in their own local chat instance.
+
+<a href="static/docu/share.png">
+  <img src="static/docu/share.png" alt="Share chats" height="300">
+</a>
+
+### Change advanced settings
+
+SlickGPT allows you to customize all parameters the OpenAI API offers to your liking. You can change the model, temperature, top_p, and frequency_penalty parameters to get the best results. You can also set the the chat context (or "system" message) to guide the AI model and shape its behaviour and answers and even use "stop sequences" to limit the answers you get.
+
+<a href="static/docu/settings.png">
+  <img src="static/docu/settings.png" alt="Settings" height="300">
+</a>
+
+### Detailed token calculation
+
+SlickGPT provides an in-built token cost calculator for your chats. You can see the cost of your chat in real-time as you type and receive answers. This allows you to keep track of and control your API usage. SlickGPT also has a posh pie chart that visualizes the cost distribution within a chat.
+
+<a href="static/docu/tokens.png">
+  <img src="static/docu/tokens.png" alt="Token calculation" height="300">
+</a>
+
+### Change context
+
+Do you know what "context" is when talking to ChatGPT? Most users don't and that's why SlickGPT displays and explains the concept very clearly with explanations and examples when you start a new chat. This way, one of the most powerful features just becomes "part of the chat".
+
+<a href="static/docu/context.png">
+  <img src="static/docu/context.png" alt="Set context" height="300">
+</a>
+
+### Switch between light and dark mode
+
+SlickGPT offers a light and dark theme. You can switch between the two modes by clicking the toggle button in the top right corner and once you do, it will remember your choice.
+
+<a href="static/docu/light.png">
+  <img src="static/docu/light.png" alt="Switch theme" height="300">
+</a>
+
+<p align="right">[ <a href="#readme-top">back to top</a> ]</p>
+
+## Comparison with ChatGPT
+
+While ChatGPT offers a great conversational AI experience, it lacks some features many users desire.
+
+| Feature                     | SlickGPT | ChatGPT |
+| --------------------------- | -------- | ------- |
+| Use different models        | ✅       | ✅      |
+| Chat history                | ✅       | ✅      |
+| Highlight / Format code     | ✅       | ✅      |
+| Use Your Own API Key        | ✅       | ✅      |
+| Host Yourself / Run Locally | ✅       | ❌      |
+| Share Chats                 | ✅       | ❌      |
+| Set Context                 | ✅       | ❌      |
+| Change model configuration  | ✅       | ❌      |
+| No Login Required           | ✅       | ❌      |
+| Token Cost Calculation      | ✅       | ❌      |
+| Mobile-first design         | ✅       | ❌      |
+| Edit and branch messages    | ❌       | ✅      |
+| Stop generation             | ❌       | ✅      |
+
+As you can see, SlickGPT includes several additional features that cater to a broad range of user needs, such as hosting the service yourself, using a local chat history, sharing chats, and customizing the chat configurations. Moreover, SlickGPT does not require a login, allowing for faster and more streamlined access. These added functionalities make SlickGPT a more versatile and convenient solution for users seeking an advanced ChatGPT experience.
+
+<p align="right">[ <a href="#readme-top">back to top</a> ]</p>
+
+<!-- ROADMAP -->
+
+## Roadmap
+
+- [x] Add light/dark mode switch
+- [ ] Add theme switcher
+- [ ] Editable messages and branching chat history
+- [ ] Stop generating
+- [ ] More documentation
+- [ ] i18n
+  - [ ] English
+  - [ ] German
+
+See the [open issues](https://github.com/ShipBit/slickgpt/issues) for a full list of proposed features and known issues.
+
+<p align="right">[ <a href="#readme-top">back to top</a> ]</p>
+
+## Contribution Guidelines
+
+Contributions are always welcome! Feel free to open a pull request, report bugs, or submit feature requests. Please follow the Code of Conduct and Contribution Guidelines when participating in this project.
+
+### Main Contributors
+
+<p>
+  <img src="https://alqxoepsjp.cloudimg.io/v7/_shipbit_/team/Simon.png?w=128&h=128&func=face&face_margin=30&radius=9999&force_format=webp" alt="A portrait of Simon Hopstätter" height="100">
+  <br>
+  <span>Simon Hopstätter</span>
+</p>
+<p>
+  <img src="https://alqxoepsjp.cloudimg.io/v7/_shipbit_/team/Timo.png?w=128&h=128&func=face&face_margin=30&radius=9999&force_format=webp" alt="A portrait of Timo Korinth" height="100">
+  <br>
+  <span>Timo Korinth</span>
+</p>
+
+<p align="right">[ <a href="#readme-top">back to top</a> ]</p>
+
+## License
+
+This project is licensed under the MIT License.
+
+## Contact
+
+SlickGPT was initially created by [Simon Hopstätter](https://www.shipbit.de/team) and [Timo Korinth](https://www.shipbit.de/team) at [Shipbit](https://www.shipbit.de).
+
+If you have any questions, feel free to contact us.
+
+<a href="https://www.shipbit.de">
+  <img src="static/shipbit-logo.svg" alt="Logo" height="100">
+</a>
+
+<p align="right">[ <a href="#readme-top">back to top</a> ]</p>
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/ShipBit/slickgpt.svg?style=for-the-badge
+[contributors-url]: https://github.com/ShipBit/slickgpt/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/ShipBit/slickgpt.svg?style=for-the-badge
+[forks-url]: https://github.com/ShipBit/slickgpt/network/members
+[stars-shield]: https://img.shields.io/github/stars/ShipBit/slickgpt.svg?style=for-the-badge
+[stars-url]: https://github.com/ShipBit/slickgpt/stargazers
+[issues-shield]: https://img.shields.io/github/issues/ShipBit/slickgpt.svg?style=for-the-badge
+[issues-url]: https://github.com/ShipBit/slickgpt/issues
+[license-shield]: https://img.shields.io/github/license/ShipBit/slickgpt.svg?style=for-the-badge
+[license-url]: https://github.com/ShipBit/slickgpt/blob/master/LICENSE
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://www.linkedin.com/company/shipbit/
+[slickgpt-screenshot]: static/docu/hero-image.png
+[svelte-shield]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte
+[svelte-url]: https://svelte.dev/
+[sveltekit-shield]: https://img.shields.io/badge/SvelteKit-4A4A55?style=for-the-badge&logo=svelte
+[sveltekit-url]: https://kit.svelte.dev/
+[openai-shield]: https://img.shields.io/badge/OpenAI-4A4A55?style=for-the-badge&logo=openai
+[openai-url]: https://openai.com/