Skip to content

Commit

Permalink
readme: Use new package import path.
Browse files Browse the repository at this point in the history
Signed-off-by: Ruben Jenster <[email protected]>
  • Loading branch information
r10r committed Jun 7, 2021
1 parent 09e2a93 commit f043545
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ cover:
@`which go` tool cover -func=/tmp/unpriv.out || true

doc:
@`which godoc` gopkg.in/lxc/go-lxc.v2 | less
@`which go` doc github.com/lxc/go-lxc | less

vet:
@echo "$(OK_COLOR)==> Running go vet $(NO_COLOR)"
Expand Down
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ This package implements [Go](https://golang.org) bindings for the [LXC](https://
Type | Service | Status
--- | --- | ---
CI (Linux) | Github | [![CI tests](https://github.com/lxc/go-lxc/actions/workflows/test.yml/badge.svg?branch=v2)](https://github.com/lxc/go-lxc/actions/workflows/test.yml)
Go documentation | Godoc | [![GoDoc](https://godoc.org/gopkg.in/lxc/go-lxc.v2?status.svg)](https://godoc.org/gopkg.in/lxc/go-lxc.v2)
Static analysis | GoReport | [![Go Report Card](https://goreportcard.com/badge/gopkg.in/lxc/go-lxc.v2)](https://goreportcard.com/report/gopkg.in/lxc/go-lxc.v2)
Go documentation | Godoc | [![GoDoc](https://godoc.org/github.com/lxc/go-lxc?status.svg)](https://godoc.org/github.com/lxc/go-lxc)
Static analysis | GoReport | [![Go Report Card](https://goreportcard.com/badge/github.com/lxc/go-lxc)](https://goreportcard.com/report/github.com/lxc/go-lxc)

## Requirements

Expand All @@ -31,15 +31,15 @@ sudo apt install git golang gcc make liblxc1 liblxc-dev lxc-utils pkg-config
To install it, run:

```bash
go get gopkg.in/lxc/go-lxc.v2
go get github.com/lxc/go-lxc
```

## Trying

To try examples, run:

```bash
# cd ~/go/src/gopkg.in/lxc/go-lxc.v2/examples/
# cd ~/go/src/github.com/lxc/go-lxc/examples/

# make
==> Running go vet
Expand All @@ -62,17 +62,13 @@ exit
2018/12/27 22:39:52 RunCommand
uid=0(root) gid=0(root) groups=0(root)

# stop/stop
# stop/stop
2018/12/27 22:39:54 Stopping the container...

# destroy/destroy
# destroy/destroy
2018/12/27 22:39:57 Destroying container...
```

## Stability

The package API will remain stable as described in [gopkg.in](https://gopkg.in).

## Backwards Compatibility

LXC has always focused on strong backwards compatibility. In fact, the API hasn't been broken from release `1.0.0` onwards. Main LXC is currently at version `2.*.*`.
Expand Down

0 comments on commit f043545

Please sign in to comment.