添加README

README.md

@@ -0,0 +1,68 @@
+# docker.cattysteve.top使用说明
+
+**注意：当前镜像源处于试运行状态，可能随时有变化。有疑问请联系pig2014。**
+
+## 使用须知
+
+拉取时服务器会先向上游请求数据，因此**开始拉取后暂时无响应是正常状态**。
+
+上游(`https://daocloud.io`)存在速率限制，且服务器流量收费，因此使用时请遵循以下限制：
+1. 拉取不快于每分钟1次
+2. 单次拉取不超过1GB
+
+若超出限制，可能会：
+1. 被WAF防火墙阻断
+2. 拉取无速度
+3. 服务器被上游拉黑
+
+若发生违例，请联系pig2014手动处理。
+
+## docker/podman
+
+登录：
+```sh
+docker login docker.cattysteve.top
+# (按提示输入用户和密码)
+```
+
+手动：
+```sh
+docker pull docker.cattysteve.top/docker.io/example/example:latest
+```
+
+自动：
+在`/etc/docker/daemon.json`添加：
+```json
+{
+    "registry-mirrors": ["https://docker.cattysteve.top/docker.io"]
+}
+```
+
+## k8s/containerd
+
+在`/etc/containerd/containerd.conf`找到相应位置并修改：
+```toml
+    [plugins."io.containerd.grpc.v1.cri".registry]
+      [plugins."io.containerd.grpc.v1.cri".registry.mirrors]
+        [plugins."io.containerd.grpc.v1.cri".registry.mirrors."registry.k8s.io"]
+          endpoint = ["https://docker.cattysteve.top/registry.k8s.io"]
+      [plugins."io.containerd.grpc.v1.cri".registry.configs]
+        [plugins."io.containerd.grpc.v1.cri".registry.configs."https://docker.cattysteve.top/registry.k8s.io".auth]
+          username="你的用户名"
+          password="你的密码"
+```
+
+## k3s
+
+在`/etc/rancher/k3s/registries.yaml`添加：
+```yaml
+mirrors:
+  docker.io:
+    endpoint:
+      - "https://docker.cattysteve.top/docker.io"
+configs:
+  "https://docker.cattysteve.top/docker.io":
+    auth:
+      username: "你的用户名"
+      password: "你的密码"
+```