chore: update docs and examples

Signed-off-by: peefy <xpf6677@163.com>
crossplane-contrib · Dec 20, 2023 · f5bbcf7 · f5bbcf7
1 parent 769b5da
commit f5bbcf7
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,4 @@
 vendor/
 .kclvm
 .DS_store
+package/*.xpkg
diff --git a/README.md b/README.md
@@ -12,13 +12,13 @@ $ go generate ./...
 $ go test ./...
 
 # Build the function's runtime image - see Dockerfile
-$ docker build . --tag=runtime
+$ docker build . --tag=kcllang/crossplane-kcl
 
 # Build a function package - see package/crossplane.yaml
-$ crossplane xpkg build -f package --embed-runtime-image=runtime
+$ crossplane xpkg build -f package --embed-runtime-image=kcllang/crossplane-kcl
 ```
 
-## Examples
+## Quick Start Examples
 
 See [here](./examples/resources/basic/)
 

diff --git a/examples/resources/basic/README.md b/examples/resources/basic/README.md
@@ -1,4 +1,4 @@
-# Example manifests
+# Example Manifests
 
 You can run your function locally and test it using `crossplane beta render`
 with these example manifests.

diff --git a/examples/resources/basic/functions.yaml b/examples/resources/basic/functions.yaml
@@ -3,4 +3,4 @@ kind: Function
 metadata:
   name: kcl-function
 spec:
-  package: kcllang/crossplane-kcl:v0.1.0
+  package: kcllang/crossplane-kcl
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,3 +15,4 @@ @@
     vendor/
     .kclvm
     .DS_store
+    package/*.xpkg