From 6cbea4566919aded0d6f5f4ca1e7c807be0de29d Mon Sep 17 00:00:00 2001 From: Gus Eggert Date: Fri, 2 Dec 2022 13:34:32 -0500 Subject: [PATCH] Add basic readme --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6678a7c28..06a4f1544 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,13 @@ -Repository Name +go-libipfs ======================= -> Repository tagline +> A library for building IPFS implementations -A longer repository description. +Go-libips is a library for building IPFS implementations and tools in Go. It contains reusable functionality useful for interacting and experimenting with IPFS. -## Documentation +This is also used by [Kubo](https://github.com/ipfs/kubo) for its core functionality. -[Insert link to documentation]() or expand with Install, Build, Usage sections. - -## Lead Maintainer - -[Your name](https://github.com/alinktoyourname) +Currently this library is a target for consolidating Go IPFS repositories, and will receive minor version releases as repositories are consolidated into it. We are initially focused on merely consolidating repositories, *not* refactoring across packages. Once repositories are mostly consolidated, *then* we will begin refactoring this library holistically. Individual components can still be worked on and refactored individually, but please refrain from trying to refactor across components. ## Contributing