Skip to content

docs: point README badges and install/import at oasdiff/yaml #14

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
reuvenharrison merged 1 commit into from
Jun 24, 2026
Merged

docs: point README badges and install/import at oasdiff/yaml #14

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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# YAML marshaling and unmarshaling support for Go

[![Lint](https://github.com/invopop/yaml/actions/workflows/lint.yaml/badge.svg)](https://github.com/invopop/yaml/actions/workflows/lint.yaml)
[![Test Go](https://github.com/invopop/yaml/actions/workflows/test.yaml/badge.svg)](https://github.com/invopop/yaml/actions/workflows/test.yaml)
[![Go Report Card](https://goreportcard.com/badge/github.com/invopop/yaml)](https://goreportcard.com/report/github.com/invopop/yaml)
![Latest Tag](https://img.shields.io/github/v/tag/invopop/yaml)
[![Lint](https://github.com/oasdiff/yaml/actions/workflows/lint.yaml/badge.svg)](https://github.com/oasdiff/yaml/actions/workflows/lint.yaml)
[![Test Go](https://github.com/oasdiff/yaml/actions/workflows/test.yaml/badge.svg)](https://github.com/oasdiff/yaml/actions/workflows/test.yaml)
[![Go Report Card](https://goreportcard.com/badge/github.com/oasdiff/yaml)](https://goreportcard.com/report/github.com/oasdiff/yaml)
![Latest Tag](https://img.shields.io/github/v/tag/oasdiff/yaml)

## Fork
This fork is an improved version of the invopop/yaml package, designed to include line and column location information for YAML elements during unmarshalling.
Expand Down Expand Up @@ -63,13 +63,13 @@ GOOD:
To install, run:

```
$ go get github.com/invopop/yaml
$ go get github.com/oasdiff/yaml
```

And import using:

```
import "github.com/invopop/yaml"
import "github.com/oasdiff/yaml"
```

Usage is very similar to the JSON library:
Expand All @@ -80,7 +80,7 @@ package main
import (
"fmt"

"github.com/invopop/yaml"
"github.com/oasdiff/yaml"
)

type Person struct {
Expand Down Expand Up @@ -124,7 +124,7 @@ package main
import (
"fmt"

"github.com/invopop/yaml"
"github.com/oasdiff/yaml"
)

func main() {
Expand Down