Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 3e7353f

Browse files
authoredJul 20, 2022
chore: houseclean ipfs/README (#4156)
* Houseclean README.md
1 parent 89db371 commit 3e7353f

File tree

1 file changed

+4
-16
lines changed

1 file changed

+4
-16
lines changed
 

‎packages/ipfs/README.md

+4-16
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,7 @@
44
</a>
55
</p>
66

7-
<h3 align="center">The JavaScript implementation of the IPFS protocol</h3>
8-
9-
<p align="center">
10-
<a href="https://riot.im/app/#/room/#ipfs-dev:matrix.org"><img src="https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat" /> </a>
11-
<a href="http://webchat.freenode.net/?channels=%23ipfs"><img src="https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat" /></a>
12-
<a href="https://discord.gg/24fmuwR"><img src="https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord&style=flat" /></a>
13-
<a href="https://github.com/ipfs/team-mgmt/blob/master/MGMT_JS_CORE_DEV.md"><img src="https://img.shields.io/badge/team-mgmt-blue.svg?style=flat" /></a>
14-
</p>
7+
<h3 align="center">An <a href="https://docs.ipfs.io/basics/ipfs-implementations/">IPFS protocol implementation</a> written in JS</h3>
158

169
<p align="center">
1710
<a href="https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core"><img src="https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg"></a>
@@ -27,8 +20,6 @@
2720
<br>
2821
</p>
2922

30-
> **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).
31-
3223
`ipfs` is the core API, a CLI and a HTTP server that functions as a HTTP to IPFS bridge and an RPC endpoint.
3324

3425
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
4334

4435
## Getting Started
4536

46-
We've come a long way, but this project is still in Alpha, lots of development is happening, APIs might change, beware of 🐉..
47-
4837
### Install
4938

5039
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
7261
* Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)
7362
* 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
7463
* 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
75-
* Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
7664
* Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
7765
* Check out https://docs.ipfs.io for tips, how-tos and more
7866
* See https://blog.ipfs.io for news and more
@@ -82,18 +70,18 @@ added QmXXY5ZxbtuYj6DnfApLiGstzPN7fvSyigrRee3hDWPCaf hello-world.txt
8270

8371
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
8472

85-
The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
73+
This IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:
8674

8775
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).
8876

8977
- **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
90-
- **Look at the [IPFS Roadmap](https://github.com/ipfs/roadmap)** This are the high priority items being worked on right now
9178
- **Perform code reviews** More eyes will help
9279
a. speed the project along
9380
b. ensure quality, and
9481
c. reduce possible future bugs.
9582
- **Add tests**. There can never be enough tests.
96-
- **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
83+
84+
Find out about chat channels, the IPFS newsletter, the IPFS blog, and more in the [IPFS community space](https://docs.ipfs.io/community/).
9785

9886
## License
9987

0 commit comments

Comments
 (0)
This repository has been archived.