Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CrazyNeil authored Oct 17, 2024
1 parent a15a71b commit e65584d
Showing 1 changed file with 26 additions and 31 deletions.
57 changes: 26 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,59 @@
# OllamaSpring
OllamaSpring is a comprehensive macOS client for managing the various models offered by the ollama community (Now also support Groq API service), and for creating conversational AI experiences. This is an open-source and free software project, and we welcome more users and developers to participate in it.

- Support all Ollama Models
- Control Stream Response
- Models download and delete
- Conversations and History Context
- Customize preferred response language
- Automatically checks for and installs OllamaSpring's updates
- Quick installation by entering the model name
- Image, PDF and txt file input
- Model Options modification
- Quick Completion
- Groq Fast API support
- Http Proxy

https://www.ollamaspring.com
OllamaSpring is a comprehensive macOS client for managing the various models offered by the Ollama community (now with support for Groq API services), and for creating conversational AI experiences. This is an open-source and free software project, and we welcome users and developers to participate.

- Supports all Ollama Models
- Stream Response Control
- Model Download and Deletion
- Conversation and History Contexts
- Customizable Response Language
- Automatic Updates for OllamaSpring
- Quick Installation by Entering Model Name
- Image, PDF, and TXT File Input
- Model Option Modifications
- Quick Completion Feature
- Groq Fast API Support
- HTTP Proxy Configuration

Visit our website: https://www.ollamaspring.com

<img width="700" alt="ollamaSpring-main jpg" src="https://github.com/CrazyNeil/OllamaSpring/assets/5747549/cd9e01e7-70d4-47c0-a879-55d02f5f1dc2">

# New Features

### Groq Fast API

If your Mac computer is not powerful enough to run the Ollama open-source models locally, you can now choose to use the Groq Fast API service. All you need is to obtain the [Groq API key](https://groq.com) to experience fast access to large open-source models.
If your Mac is not powerful enough to run the Ollama open-source models locally, you can now use the Groq Fast API service. All you need is a [Groq API key](https://groq.com) to experience fast access to large open-source models.

<img width="700" alt="ollamaSpring-main jpg" src="https://github.com/user-attachments/assets/1c8f16da-3209-4567-bd3a-b26642c9e1a4">

### HTTP Proxy

### Http Proxy

If your network accesses the internet through an HTTP proxy, now you can configure it using the Http Proxy feature in OllamaSpring (Tool Bar).
If your network accesses the internet through an HTTP proxy, you can now configure it using the HTTP Proxy feature in OllamaSpring (available in the toolbar).

### Quick Completion

Quick Completion allow you send prompt in a fast way and active it by cmd + shift + h, update OllamaSpring to v1.1.5+ or just install it from [Releases](https://github.com/CrazyNeil/OllamaSpring/releases) section.
Quick Completion allows you to send prompts quickly by activating it with cmd + shift + h. Update OllamaSpring to v1.1.5+ or install it from the [Releases](https://github.com/CrazyNeil/OllamaSpring/releases) section.

<img width="700" alt="ollamaSpring-main jpg" src="https://github.com/user-attachments/assets/0a6109b8-ab0a-454b-b9c8-627a27a43c3d">



# Download & Install

System Requirements:
- macOS 14.0 or later
- [Ollama](https://ollama.com) installed

Download the latest release package ( latest v1.2.0 ) from the [Releases](https://github.com/CrazyNeil/OllamaSpring/releases) section.
Simply unzip the package and drag it into your Application folder. Or install sandbox version ( v1.1.4 ) from app store. _Notice: The sandbox version needs to undergo Apple App Store review. For the latest updates and versions as soon as possible, we recommend using the binary installation package._
Download the latest release package (v1.2.0) from the [Releases](https://github.com/CrazyNeil/OllamaSpring/releases) section. Simply unzip the package and drag it into your Applications folder, or install the sandbox version (v1.1.4) from the App Store. _Note: The sandbox version is subject to Apple App Store review. For the latest updates, we recommend using the binary installation package._

<a href="https://apps.apple.com/us/app/ollamaspring/id6502970995">
<img src="https://github.com/CrazyNeil/OllamaSpring/assets/5747549/a37c4931-9420-431d-a0b7-c2cc0fdc27fe" alt="Description" width="150"/>
<img src="https://github.com/CrazyNeil/OllamaSpring/assets/5747549/a37c4931-9420-431d-a0b7-c2cc0fdc27fe" alt="App Store" width="150"/>
</a>

# Run & Build

You can clone this project and build it using Xcode 14 or later.

## Setup Update Server
OllamaSpring uses [Sparkle](https://sparkle-project.org) as a built-in update framework. You need to make a few changes to set up your own update service.
OllamaSpring uses [Sparkle](https://sparkle-project.org) as its built-in update framework. You need to make a few changes to set up your own update service.

### 1. Generate EdDSA Key

Expand All @@ -71,15 +67,14 @@ OllamaSpring uses [Sparkle](https://sparkle-project.org) as a built-in update fr
- SUPublicEDKey: (Your EdDSA public key)

### 3. Sandbox
OllamaSpring disables Sandbox in .entitlements. If you want to use it, you should follow the [Sparkle sandboxing guide](https://sparkle-project.org/documentation/sandboxing/).
OllamaSpring disables the sandbox in .entitlements. If you want to enable it, follow the [Sparkle sandboxing guide](https://sparkle-project.org/documentation/sandboxing/).

### 4. Publish your appcast

Build your app and compress it (e.g. in a ZIP/tar.xz/DMG archive), and put the archive in a new folder. This folder will be used to store all your future updates.
Build your app, compress it (e.g. ZIP/tar.xz/DMG archive), and place the archive in a folder for storing future updates.

```bash
./bin/generate_appcast /path/to/your/updates_folder/
```
Upload your archives and the appcast to your server.


Upload your archives and appcast to your server.

0 comments on commit e65584d

Please sign in to comment.