diff --git a/README.md b/README.md index fed8ef7..028dab4 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/pkg/golamify/model.go b/pkg/golamify/model.go index fdf0b32..309a4fd 100644 --- a/pkg/golamify/model.go +++ b/pkg/golamify/model.go @@ -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) {