add generator for readme

Signed-off-by: cuisongliu <cuisongliu@qq.com>

Author: cuisongliu

generator/default.go

@@ -64,7 +64,7 @@ func Do() {
 		goRunData[markdown.Apps] = got.Apps
 	}
 
-	if err = markdown.NewReadme().Generator(syncDir); err != nil {
+	if err = markdown.NewReadme(syncHub).Generator(syncDir); err != nil {
 		logger.Fatal("markdown.NewReadme().Generator error %s", err.Error())
 		return
 	}

generator/markdown/readme.md.go

@@ -17,8 +17,10 @@ limitations under the License.
 package markdown
 
 import (
+	"fmt"
 	"os"
 	"path"
+	"strings"
 )
 
 const readmeTemplate = `# Cluster Image Directory
@@ -29,14 +31,24 @@ Welcome to our documentation folder, where we list four distinct types of cluste
 - [Sealos Images](./sealos.md)
 - [Laf Images](./laf.md)
 - [Application Images](./apps.md)
+
+Please navigate to the above links to access the detailed documentation for each image category.
+
+## Image Repository
+
+The images in this documentation are hosted on our dedicated image repository:  %s
+
 `
 
-type readme struct{}
+type readme struct {
+	addr string
+}
 
 func (r *readme) Generator(dir string) error {
-	return os.WriteFile(path.Join(dir, "README.md"), []byte(readmeTemplate), 0644)
+	return os.WriteFile(path.Join(dir, "README.md"), []byte(fmt.Sprintf(readmeTemplate, "`"+r.addr+"`")), 0644)
 }
 
-func NewReadme() Template {
-	return &readme{}
+func NewReadme(addr string) Template {
+	registryArr := strings.Split(addr, "/")
+	return &readme{addr: registryArr[0]}
 }

generator/markdown/readme.md_test.go

@@ -0,0 +1,55 @@
+/*
+Copyright 2023 cuisongliu@qq.com.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package markdown
+
+import "testing"
+
+func Test_readme_Generator(t *testing.T) {
+	type fields struct {
+		addr string
+	}
+	type args struct {
+		dir string
+	}
+	tests := []struct {
+		name    string
+		fields  fields
+		args    args
+		wantErr bool
+	}{
+		{
+			name: "default",
+			fields: fields{
+				addr: "docker.io",
+			},
+			args: args{
+				dir: "../../tmp",
+			},
+			wantErr: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			r := &readme{
+				addr: tt.fields.addr,
+			}
+			if err := r.Generator(tt.args.dir); (err != nil) != tt.wantErr {
+				t.Errorf("Generator() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}

tmp/README.md

@@ -0,0 +1,15 @@
+# Cluster Image Directory
+
+Welcome to our documentation folder, where we list four distinct types of cluster images: Rootfs Images, Sealos-related Images, Laf-related Images, and Images for various applications.
+
+- [Rootfs Images](./rootfs.md)
+- [Sealos Images](./sealos.md)
+- [Laf Images](./laf.md)
+- [Application Images](./apps.md)
+
+Please navigate to the above links to access the detailed documentation for each image category.
+
+## Image Repository
+
+The images in this documentation are hosted on our dedicated image repository:  `docker.io`
+