From 37c5c4fa0755dd575271cb7029b01be6ad1e08e6 Mon Sep 17 00:00:00 2001
From: andy Augustin <AndreasAugustin@users.noreply.github.com>
Date: Wed, 5 Aug 2020 06:04:28 +0200
Subject: [PATCH] doc(README): add description how to use the action  (#2)
 (#22)

---
 README.md | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 95847645..d1b776c4 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,50 @@
-# template
+# actions-template-sync
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ![Lint](https://github.com/AndreasAugustin/actions-template-sync/workflows/Lint/badge.svg)
 
+It is possible to create repositories within Github with
+[GitHub templates](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository).
+This is a nice approach to have some boilerplate within your repository.
+Over the time the template repository will get some code changes.
+The problem is that the already created repositories won't know about those changes.
+This GitHub action will help you to keep track of the template changes.
+
+## Features
+
+* Sync template repository with the current repository
+
+## Usage
+
+### GitHub Actions
+
+Add this configuration to your github action
+
+```yaml
+# File: .github/workflows/template-sync.yml
+
+on:
+  schedule:
+  - cron:  "*/15 * * * *"
+jobs:
+  repo-sync:
+    runs-on: ubuntu-latest
+
+    steps:
+      # To use this repository's private action, you must check out the repository
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: actions-template-sync
+        uses: actions/actions-template-sync
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          source_repo_path: <the_path_to_the_repo>
+```
+
+You will receive a pull request within your repository if there are some changes available.
+
 ## DEV
 
 The development environment targets are located in the [Makefile](Makefile)