From b74cfd14308942c0dc8a852c6eba272266dd0aca Mon Sep 17 00:00:00 2001
From: ttionya <git@ttionya.com>
Date: Tue, 2 Jun 2020 16:27:59 +0800
Subject: [PATCH] docs: add README.md file

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..63d3289
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Repository Sync Hub
+
+A GitHub Actions for sync current repository to other hub.
+
+## Features
+
+- Sync branches and tags to other repository (GitHub, GitLab, Gitee, etc.)
+- Automatic delete branches and tags that is deleted
+
+## Usage
+
+Be sure to run the [actions/checkout](https://github.com/actions/checkout) in a step before this action.
+
+```yml
+# File .github/workflows/sync.yml
+
+steps:
+  - uses: actions/checkout@v2
+    with:
+      fetch-depth: 0
+  - uses: ttionya/Repository-Sync-Hub@v1
+    with:
+      # Sync to target repository full clone URL (SSH Only)
+      target_repository: 'git@github.com:ttionya/Repository-Sync-Hub-Test.git'
+      # SSH key used to authenticate with git operations (optional)
+      ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }}
+```
+
+More usage please see [sample workflows](/.github/workflows/test.yml).
+
+## Thanks
+
+Inspired by the following actions which may be more suitable for your workflow.
+
+- [wei/git-sync](https://github.com/wei/git-sync)
+- [net-engine/github-repository-sync-action](https://github.com/net-engine/github-repository-sync-action)
+
+## License
+
+MIT