Merge pull request #5 from wanjunlei/java

prepare for release 1.0.0

Author: benjaminhuo

.github/workflows/publish.yaml

@@ -2,7 +2,7 @@ name: Maven Publish
 on:
   push:
     branches:
-      - 'main'
+      - 'master'
     tags:
       - '*'
     paths:

CHANGLOG.md

@@ -0,0 +1,4 @@
+## 1.0.0 / 2023-02-20
+
+The first release version.
+

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'
+    }
+
+```