Skip to content

Commit e2a2fec

Browse files
authored
docs: update (#26)
1 parent 0162cc0 commit e2a2fec

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@
66
[![CodeQL]][code-ql]
77
[![Go Report Card]][go-report-card]
88
[![codecov]][code-cov]
9-
10-
![cluster-ops]
9+
[![release-tag]][peerd-pkgs]
1110

1211
This project implements peer to peer distribution of content (such as content-addressable files or OCI container images)
1312
in a Kubernetes cluster. The source of the content could be another node in the same cluster, an OCI container registry
1413
(like Azure Container Registry) or a remote blob store (such as Azure Blob Storage).
1514

15+
![cluster-ops]
16+
1617
#### Important Disclaimer
1718

1819
This is **work in progress** and not yet production ready. We are actively working on this project and would love to
@@ -28,8 +29,6 @@ If you have a k8s cluster that uses containerd as the runtime, you can use the p
2829
pods on every node. With containerd, Peerd leverages the [hosts configuration][containerd hosts] to act as a mirror for
2930
container images.
3031

31-
[![release-tag]][peerd-pkgs]
32-
3332
```bash
3433
CLUSTER_CONTEXT=<your-cluster-context> && \
3534
TAG=<docker-image-tag> && \
@@ -62,11 +61,9 @@ To see logs from the Peerd pods, run the following.
6261
kubectl --context=$CLUSTER_CONTEXT -n peerd-ns logs -l app=peerd -f
6362
```
6463

65-
Further details on building can be found in [build.md].
66-
6764
## Features
6865

69-
* **Peer to Peer File Sharing**: Peerd llows a node to act as a mirror for files obtained from any HTTP upstream source
66+
* **Peer to Peer File Sharing**: Peerd allows a node to act as a mirror for files obtained from any HTTP upstream source
7067
(such as an [Azure Blob] using a [SAS URL]), and can discover and serve a specified byte range of the file to/from
7168
other nodes in the cluster. Peerd will first attempt to discover and serve this range from its peers. If not found, it
7269
will fallback to download the range from the upstream URL. Peerd caches downloaded ranges as well as optionally, can
@@ -91,6 +88,10 @@ Further details on building can be found in [build.md].
9188

9289
The APIs are described in the [swagger.yaml].
9390

91+
## Build
92+
93+
See [build.md].
94+
9495
## Design and Architecture
9596

9697
See [design.md].

0 commit comments

Comments
 (0)