Skip to content

docs: fix README.md #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
murfffi merged 1 commit into from
Sep 16, 2025
Merged

docs: fix README.md #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,21 @@ Use ```-help``` to see additional options
## Usage as a library

```go
package main

import (
"github.com/murfffi/getaduck"
"fmt"
"fmt"

"github.com/murfffi/getaduck/download"
)

func main() {
// Download the latest DuckDB release for your platform
duckdbPath, err := getaduck.Download(getaduck.Options{})
if err != nil {
panic(err)
}
fmt.Println("Downloaded DuckDB to:", duckdbPath)
// Download the latest DuckDB release for your platform
res, err := download.Do(download.DefaultSpec())
if err != nil {
panic(err)
Copy link

@gemini-code-assist gemini-code-assist bot Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better error handling in this example, consider using log.Fatal(err) instead of panic(err). log.Fatal is generally preferred for exiting a program from main on an unrecoverable error, as it provides a clean exit without a stack trace. This would also make the example consistent with the error handling in the project's main.go file.

To apply this change, you will also need to add "log" to the import block.

Suggested change
panic(err)
log.Fatal(err)

}
fmt.Println("Downloaded DuckDB to:", res.OutputFile)
}
```

Expand Down
Loading