From 5ac9a545830c0267ede414aacd4b8da50dc6970f Mon Sep 17 00:00:00 2001
From: wanjunlei <wanjunlei@kubesphere.io>
Date: Mon, 20 Feb 2023 17:20:18 +0800
Subject: [PATCH] prepare for release 1.0.0

Signed-off-by: wanjunlei <wanjunlei@kubesphere.io>
---
 .github/workflows/publish.yaml |  2 +-
 CHANGLOG.md                    |  4 ++++
 README.md                      | 26 ++++++++++++++++++++++++++
 3 files changed, 31 insertions(+), 1 deletion(-)
 create mode 100644 CHANGLOG.md

diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
index 9686c419..9017101b 100644
--- a/.github/workflows/publish.yaml
+++ b/.github/workflows/publish.yaml
@@ -2,7 +2,7 @@ name: Maven Publish
 on:
   push:
     branches:
-      - 'main'
+      - 'master'
     tags:
       - '*'
     paths:
diff --git a/CHANGLOG.md b/CHANGLOG.md
new file mode 100644
index 00000000..bb13932d
--- /dev/null
+++ b/CHANGLOG.md
@@ -0,0 +1,4 @@
+## 1.0.0 / 2023-02-20
+
+The first release version.
+
diff --git a/README.md b/README.md
index cbda9fc2..a09176ca 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,29 @@
 # Functions Framework for Java
 
 An open source FaaS (Function as a service) framework for writing portable Java functions.
+
+## How to use
+
+A function is typically structured as a Maven project. We recommend using an IDE
+that supports Maven to create the Maven project. Add this dependency in the
+`pom.xml` file of your project:
+
+```xml
+    <dependencies>
+        <dependency>
+            <groupId>dev.openfunction.functions</groupId>
+            <artifactId>functions-framework-api</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+    </dependencies>
+```
+
+If you are using Gradle to build your functions, you can define the Functions
+Framework dependency in your `build.gradle` project file as follows:
+
+```groovy
+    dependencies {
+        implementation 'dev.openfunction.functions:functions-framework-api:1.0.0'
+    }
+
+```