Skip to content

Commit

Permalink
add a prominent link to the API docs to the README (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlange-42 authored Apr 4, 2023
1 parent c15283c commit f7a1952
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Arche pixel
# Arche Pixel

[![Test status](https://img.shields.io/github/actions/workflow/status/mlange-42/arche-pixel/tests.yml?branch=main&label=Tests&logo=github)](https://github.com/mlange-42/arche-pixel/actions/workflows/tests.yml)
[![Go Reference](https://pkg.go.dev/badge/github.com/mlange-42/arche-pixel.svg)](https://pkg.go.dev/github.com/mlange-42/arche-pixel)
Expand All @@ -20,6 +20,12 @@ The dependencies of [go-gl/gl](https://github.com/go-gl/gl) and [go-gl/glfw](htt
- `libgl1-mesa-dev`
- `xorg-dev`

## Usage

See the [API docs](https://pkg.go.dev/github.com/mlange-42/arche-pixel) for details and examples.

[![Go Reference](https://pkg.go.dev/badge/github.com/mlange-42/arche-pixel.svg)](https://pkg.go.dev/github.com/mlange-42/arche-pixel)

## License

This project is distributed under the [MIT licence](./LICENSE).

0 comments on commit f7a1952

Please sign in to comment.