Add readme

majkrzak · Sep 16, 2019 · a84d139 · a84d139
1 parent e661f0e
commit a84d139
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+majkrzak/create-release
+=======================
+
+Github Action for handling release creation
+
+
+Example
+-------
+
+```yaml
+    - uses: majkrzak/create-release@master
+      with:
+        token: ${{github.token}}
+        name: My lovely release
+        code: latest
+        prerelease: true
+        assets: >
+          source.txt:target.txt:text/plain
+          another:one:application/json
+```
diff --git a/action.yml b/action.yml
@@ -1,4 +1,6 @@
-name: Create release
+name: majkrzak/create-release
+description: |
+  Github Action for handling release creation
 author: Piotr Majkrzak
 branding:
   icon: box