From a305076340fca275be0eeecd9ea05038f50ccf2d Mon Sep 17 00:00:00 2001 From: gammazero <11790789+gammazero@users.noreply.github.com> Date: Tue, 20 Jan 2026 13:20:49 -1000 Subject: [PATCH] Add README.md Closes #1 --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3333fff --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# go-peertaskqueue + +[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) +[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/) +[![GoDoc](https://pkg.go.dev/badge/github.com/ipfs/go-peertaskqueue)](https://pkg.go.dev/github.com/ipfs/go-peertaskqueue) +[![Build Status](https://img.shields.io/github/actions/workflow/status/ipfs/go-peertaskqueue/go-test.yml?branch=master)](https://github.com/ipfs/go-peertaskqueue/actions) + +> go-peertaskqueue implements a prioritized list of tasks to be executed on peers. + +## Table of Contents + +- [Install](#install) +- [Usage](#usage) +- [Contribute](#contribute) +- [License](#license) + +## Install + +`go-peertaskqueue` works like a regular Go module: + +``` +> go get github.com/ipfs/go-peertaskqueue +``` + +## Usage + +``` +import "github.com/ipfs/go-peertaskqueue" +``` + +Check the [GoDoc documentation](https://pkg.go.dev/github.com/ipfs/go-peertaskqueue) + +## Contribute + +PRs accepted. + +This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). + +## License + +MIT © Protocol Labs, Inc.