Skip to content

Commit

Permalink
README modifications
Browse files Browse the repository at this point in the history
  • Loading branch information
kghandour committed Oct 15, 2023
1 parent 35012b3 commit bec8038
Show file tree
Hide file tree
Showing 9 changed files with 81 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Ollama-SwiftUI
A user-friendly interface for [Ollama AI](https://ollama.ai) created in Swift. This application is not directly affiliated with Ollama.ai
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)


![Ollama SwiftUI](assets/images/OllamaNoBG256.png)
<p align="center">
<img src="assets/images/OllamaSwift.svg" width="128">
</p>
A user-friendly interface for [Ollama AI](https://ollama.ai) created in Swift. This application is not directly affiliated with Ollama.ai

**This app requires Ollama to be installed and online to function.** Install Ollama: https://ollama.ai
![Chat dialogue example](assets/images/Example1.png)
![Chat dialogue example](assets/images/LightMode1.png)

## Features
1. Chatting with local Large Language Models.
Expand All @@ -17,7 +21,7 @@ A user-friendly interface for [Ollama AI](https://ollama.ai) created in Swift. T
8. Light and Dark Mode
9. Localizable interface. Currently Localized in: English and Arabic

![Manage Models example](assets/images/Example2.png)
![Manage Models example](assets/images/LightMode2.png)

## Getting Started:
1. Install Ollama ( https://ollama.ai )
Expand All @@ -28,3 +32,11 @@ A user-friendly interface for [Ollama AI](https://ollama.ai) created in Swift. T
- Copy and paste the name and press on the download button
5. Select the model from the dropdown in the main page to start your conversation
6. Write your prompt and start the conversation!

## Dark Mode also available!
![Chat dialogue example darkmode](assets/images/DarkMode1.png)
![Chat dialogue example darkmode](assets/images/DarkMode2.png)

## Feedback and Contributions:
For bugs and feedback, please create a new issue or email [email protected]
Feel free to contribute by creating a Pull request and the best effort will be done to review and merge.
Binary file added assets/images/DarkMode1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/DarkMode2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/Example1.png
Binary file not shown.
Binary file removed assets/images/Example2.png
Binary file not shown.
Binary file added assets/images/LightMode1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/LightMode2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/OllamaNoBG256.png
Binary file not shown.
65 changes: 65 additions & 0 deletions assets/images/OllamaSwift.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bec8038

Please sign in to comment.