Skip to content

repo: updates to readme file #3

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
shoenig merged 1 commit into from
Jul 25, 2024
Merged

repo: updates to readme file #3

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
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# xtc
xtc is a substitute for the Go context package

[![Go Reference](https://pkg.go.dev/badge/noxide.lol/go/xtc.svg)](https://pkg.go.dev/noxide.lol/go/xtc)
[![License](https://img.shields.io/github/license/noxideproject/xtc?color=7C00D8&style=flat-square&label=License)](https://github.com/noxideproject/xtc/blob/main/LICENSE)
[![Build](https://img.shields.io/github/actions/workflow/status/noxideproject/xtc/ci.yaml?style=flat-square&color=0FAA07&label=Tests)](https://github.com/noxideproject/xtc/actions/workflows/ci.yaml)

`xtc` is a substitute for the Go context package.

### Requirements

The minimum Go version is `go1.21`.

### Install

Use `go get` to grab the latest version of `xtc`.

```shell
go get -u noxide.lol/go/xtc@latest
```

### License

Open source under the [BSD-3-Clause](LICENSE)