From 9abfdef557b0b16879f15dcb7b4080cca1af371a Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Wed, 6 Jul 2022 21:52:02 -0700 Subject: [PATCH 1/2] Houseclean ipfs-core/README.md --- packages/ipfs-core/README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/packages/ipfs-core/README.md b/packages/ipfs-core/README.md index 514b759703..7f361a2360 100644 --- a/packages/ipfs-core/README.md +++ b/packages/ipfs-core/README.md @@ -7,9 +7,8 @@

The JavaScript implementation of the IPFS protocol

- - - + +

@@ -31,7 +30,7 @@ > The IPFS Core API -`ipfs-core` is the implementation of the IPFS Core API. It contains all you need to integrate IPFS into your application. +`ipfs-core` is the implementation of the IPFS Core API written in JavaScript without depending on other languages/implementations. It contains all you need to integrate IPFS into your application. If you want to run IPFS as a standalone daemon process, see the [ipfs](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs) module. @@ -67,7 +66,6 @@ console.info(cid) * Look into the [js-ipfs-examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser * Read the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node -* Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it * Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs * Check out https://docs.ipfs.io for tips, how-tos and more * See https://blog.ipfs.io for news and more @@ -117,7 +115,6 @@ a. speed the project along b. ensure quality, and c. reduce possible future bugs. - **Add tests**. There can never be enough tests. -- **Join the [Weekly Core Implementations Call](https://github.com/ipfs/team-mgmt/issues/992)** it's where everyone discusses what's going on with IPFS and what's next ## License From 4a86e5d8ac5c8fd0e3a47b1c337024ff19d5ab3d Mon Sep 17 00:00:00 2001 From: Steve Loeppky Date: Fri, 8 Jul 2022 13:39:28 -0700 Subject: [PATCH 2/2] Linked to community docs --- packages/ipfs-core/README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/packages/ipfs-core/README.md b/packages/ipfs-core/README.md index 7f361a2360..bf5157353e 100644 --- a/packages/ipfs-core/README.md +++ b/packages/ipfs-core/README.md @@ -6,12 +6,6 @@

The JavaScript implementation of the IPFS protocol

-

- - - -

-

@@ -109,13 +103,14 @@ The IPFS implementation in JavaScript needs your help! There are a few things y Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md). - **Check out existing issues** The [issue list](https://github.com/ipfs/js-ipfs/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge -- **Look at the [IPFS Roadmap](https://github.com/ipfs/roadmap)** This are the high priority items being worked on right now - **Perform code reviews** More eyes will help a. speed the project along b. ensure quality, and c. reduce possible future bugs. - **Add tests**. There can never be enough tests. +Find out about chat channels, the IPFS newsletter, the IPFS blog, and more in the [IPFS community space](https://docs.ipfs.io/community/). + ## License [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-ipfs?ref=badge_large)