docs(readme): header improvements (#10144)
Marcin Rataj committed
Sep 25, 2023 at 10:07 UTC
edce05c4cf4cf47bf9de681f38cb4bd5c1a05340
1 file changed
+21
-11
README.md
+21
-11
@@ -1,25 +1,35 @@
1
<h1 align="center">
2
-<img src="https://ipfs.io/ipfs/QmTtCH31LdGV4LjRm5FNmnw6hUwZq1Z1YXtjeNKHBeaRcQ/kubo-logo.png" alt="Kubo logo" title="Kubo logo" width="200">
3
-<br>
4
-Kubo: IPFS Implementation in GO
2
+ <br>
3
+ <a href="https://docs.ipfs.tech/how-to/command-line-quick-start/"><img src="https://user-images.githubusercontent.com/157609/250148884-d6d12db8-fdcf-4be3-8546-2550b69845d8.png" alt="Kubo logo" title="Kubo logo" width="200"></a>
4
+ <br>
5
+ Kubo: IPFS Implementation in GO
6
+ <br>
7
</h1>
8
+
9
<p align="center" style="font-size: 1.2rem;">The first implementation of IPFS.</p>
10
8
-<hr />
11
+<p align="center">
12
+ <a href="https://ipfs.tech"><img src="https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square" alt="Official Part of IPFS Project"></a>
13
+ <a href="https://discuss.ipfs.tech"><img alt="Discourse Forum" src="https://img.shields.io/discourse/posts?server=https%3A%2F%2Fdiscuss.ipfs.tech"></a>
14
+ <a href="https://matrix.to/#/#ipfs-space:ipfs.io"><img alt="Matrix" src="https://img.shields.io/matrix/ipfs-space%3Aipfs.io?server_fqdn=matrix.org"></a>
15
+ <a href="https://github.com/ipfs/kubo/actions"><img src="https://img.shields.io/github/actions/workflow/status/ipfs/kubo/build.yml?branch=master" alt="ci"></a>
16
+ <a href="https://github.com/ipfs/kubo/releases"><img alt="GitHub release" src="https://img.shields.io/github/v/release/ipfs/kubo?filter=!*rc*"></a>
17
+ <a href="https://godoc.org/github.com/ipfs/kubo"><img src="https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square" alt="godoc reference"></a>
18
+</p>
19
10
-[](https://protocol.ai)
11
-[](https://godoc.org/github.com/ipfs/kubo)
20
+<hr />
21
22
## What is Kubo?
23
24
Kubo was the first IPFS implementation and is the most widely used one today. Implementing the *Interplanetary Filesystem* - the Web3 standard for content-addressing, interoperable with HTTP. Thus powered by IPLD's data models and the libp2p for network communication. Kubo is written in Go.
25
26
Featureset
18
-- Runs an IPFS-Node as a network service
19
-- [Command Line Interface](https://docs.ipfs.tech/reference/kubo/cli/) to IPFS-Nodes
20
-- Local [Web2-to-Web3 HTTP Gateway functionality](https://github.com/ipfs/specs/tree/main/http-gateways#readme)
21
-- HTTP RPC API (`/api/v0`) to access and control the daemon
22
-- IPFS's internal Webgui can be used to manage the Kubo nodes
27
+- Runs an IPFS-Node as a network service that is part of LAN and WAN DHT
28
+- [HTTP Gateway](https://specs.ipfs.tech/http-gateways/) (`/ipfs` and `/ipns`) functionality for trusted and [trustless](https://docs.ipfs.tech/reference/http/gateway/#trustless-verifiable-retrieval) content retrieval
29
+- [HTTP Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) (`/routing/v1`) client and server implementation for [delegated routing](./docs/delegated-routing.md) lookups
30
+- [HTTP Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/) (`/api/v0`) to access and control the daemon
31
+- [Command Line Interface](https://docs.ipfs.tech/reference/kubo/cli/) based on (`/api/v0`) RPC API
32
+- [WebUI](https://github.com/ipfs/ipfs-webui/#readme) to manage the Kubo node
33
34
### Other implementations
35