From 0bbf3ecb7295f981f037338a4a7698fa9395c070 Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Wed, 29 Mar 2023 09:38:54 -0700 Subject: [PATCH] Update status in README.md and added CODEOWNERS (#101) Making clear the repo status per https://github.com/ipfs/boxo/issues/218 * Update README.md * Create CODEOWNERS * Fix Boxo link * fix: @rvagg only * doc: "maintained" but not actively developed, link to alternatives --------- Co-authored-by: Rod Vagg --- CODEOWNERS | 1 + README.md | 28 +++++----------------------- 2 files changed, 6 insertions(+), 23 deletions(-) create mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..d41f1da --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +@rvagg diff --git a/README.md b/README.md index e099f3a..15d0214 100644 --- a/README.md +++ b/README.md @@ -3,35 +3,17 @@ go-merkledag [![](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/) -[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![Coverage Status](https://codecov.io/gh/ipfs/go-merkledag/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/go-merkledag/branch/master) -[![Travis CI](https://travis-ci.org/ipfs/go-merkledag.svg?branch=master)](https://travis-ci.org/ipfs/go-merkledag) > go-merkledag implements the 'DAGService' interface and adds two ipld node types, Protobuf and Raw -## Lead Maintainer +## Status -[Steven Allen](https://github.com/Stebalien) +❗ This library is maintained, but not actively developed. It will continue to receive fixes and security updates for users that depend on it. However, it may be deprecated in the future and it is recommended that you use alternatives to the functionality in go-merkledag, including: -## Table of Contents - -- [TODO](#todo) -- [Contribute](#contribute) -- [License](#license) - -## TODO - -- Pull out dag-pb stuff into go-ipld-pb -- Pull 'raw nodes' out into go-ipld-raw (maybe main one instead) -- Move most other logic to go-ipld -- Make dagservice constructor take a 'blockstore' to avoid the blockservice offline nonsense -- deprecate this package - -## Contribute - -PRs are welcome! - -Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. +* A fork of this library for use by Kubo is being maintained here: [github.com/ipfs/boxo/ipld/merkledag](https://pkg.go.dev/github.com/ipfs/boxo/ipld/merkledag) +* Working directly with DAG-PB (ProtoNode) should directly use [github.com/ipld/go-codec-dagpb](https://pkg.go.dev/github.com/ipld/go-codec-dagpb) in conjunction with [github.com/ipld/go-ipld-prime](https://pkg.go.dev/github.com/ipld/go-ipld-prime) +* Traversals / DAG walking should use [github.com/ipld/go-ipld-prime/traversal](https://pkg.go.dev/github.com/ipld/go-ipld-prime/traversal) ## License