diff --git a/packages/ipfs/README.md b/packages/ipfs/README.md index a3a4d05c0c..8d848afb73 100644 --- a/packages/ipfs/README.md +++ b/packages/ipfs/README.md @@ -4,14 +4,7 @@

-

The JavaScript implementation of the IPFS protocol

- -

- - - - -

+

An IPFS protocol implementation written in JS

@@ -27,8 +20,6 @@

-> **Upgrading from <=0.40?** See the [release notes](https://github.com/ipfs/js-ipfs/issues/2656) for the list of API changes and the [migration guide](https://github.com/ipfs/js-ipfs/tree/master/docs/docs/MIGRATION-TO-ASYNC-AWAIT.md). - `ipfs` is the core API, a CLI and a HTTP server that functions as a HTTP to IPFS bridge and an RPC endpoint. If you want to integrate IPFS into your application without including a CLI or HTTP server, see the [ipfs-core](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core) module. @@ -43,8 +34,6 @@ If you want to integrate IPFS into your application without including a CLI or H ## Getting Started -We've come a long way, but this project is still in Alpha, lots of development is happening, APIs might change, beware of 🐉.. - ### Install Installing `ipfs` globally will give you the `jsipfs` command which you can use to start a daemon running: @@ -72,7 +61,6 @@ added QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf hello-world.txt * Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) * Look into the [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser * Consult 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 @@ -82,18 +70,18 @@ added QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf hello-world.txt [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) -The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out: +This IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out: 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. -- **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 + +Find out about chat channels, the IPFS newsletter, the IPFS blog, and more in the [IPFS community space](https://docs.ipfs.io/community/). ## License