Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prasad89 committed Nov 4, 2024
1 parent 918bc04 commit fd456dd
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 3 deletions.
61 changes: 59 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,59 @@
# golamify
A Go client library for seamless integration with the Ollama API.
# GoLamify

The **GoLamify** Go package provides an easy way to integrate Go projects with **Ollama**.

## 🚀 Getting Started

### Installation

To get started with GoLamify, add the following import to your code, and use Go’s module support to automatically fetch dependencies:

```go
import "github.com/prasad89/golamify/pkg/golamify"
```

Alternatively, install it using:

```bash
go get -u github.com/prasad89/golamify
```

### 🏃 Running GoLamify

Here's a simple example to get a GoLamify application up and running:

```go
package main

import (
"fmt"
"github.com/prasad89/golamify/pkg/golamify"
)

func main() {
client, err := golamify.NewClient(nil)
if err != nil {
fmt.Println("Error creating client:", err)
return
}

resp, err := golamify.Generate(client, "llama3.2", "Why is the sky blue?")
if err != nil {
fmt.Println("Error generating response:", err)
return
}

fmt.Println("Response:", resp.Response)
}
```

### 📂 More Examples

Explore additional examples in the `examples` directory to see how you can make the most of GoLamify.

## 👍 Contributing

Help us make GoLamify even better:

- Star this repo on GitHub! 🌟
- Submit issues and pull requests for improvements and bug fixes.
2 changes: 1 addition & 1 deletion pkg/golamify/model.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type PullResponse struct {
Status string `json:"status"`
Digest string `json:"digest"`
Total string `json:"total"`
Error string `josn:"error`
Error string `josn:"error"`
}

func ShowModel(model string, c *Client) (int, error) {
Expand Down

0 comments on commit fd456dd

Please sign in to comment.