update readme and icon

yesolutions · May 11, 2019 · 3ba054d · 3ba054d
1 parent 383b0b6
commit 3ba054d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,9 +1,9 @@
 FROM alpine/git:latest
 
-LABEL "com.github.actions.name"="Mirror Action"
+LABEL "com.github.actions.name"="Mirror Repository"
 LABEL "com.github.actions.description"="Mirror git repositories"
-LABEL "com.github.actions.icon"="code"
-LABEL "com.github.actions.color"="white"
+LABEL "com.github.actions.icon"="git-commit"
+LABEL "com.github.actions.color"="green"
 
 LABEL "repository"="https://github.com/spyoungtech/mirror-action"
 LABEL "homepage"="https://github.com/spyoungtech/mirror-action"

diff --git a/README.md b/README.md
@@ -3,7 +3,9 @@ A GitHub Action for mirroring your repository to a different remote repository
 
 This project is [mirrored on GitLab](https://gitlab.com/spyoungtech/mirror-action)
 
-## Example workflow
+## Example workflows
+
+### Mirror a repository with username/password over HTTPS
 
 ```workflow
 workflow "Mirror Workflow" {
@@ -19,4 +21,11 @@ action "Mirror Action" {
     GIT_USERNAME = "spyoungtech"
   }
 }
-```
+```
+
+Be sure to set the `GIT_PASSWORD` secret in the Actions editor.
+
+### Mirror a repository using SSH
+
+*Coming soon*
+