From 2cc1d6e6c886147c8c0536a30c2b8fce81cca5a8 Mon Sep 17 00:00:00 2001
From: "Benjamin E. Coe" <bencoe@google.com>
Date: Sat, 9 May 2020 15:57:03 -0700
Subject: [PATCH] docs: starting to rough out some initial docs (#5)

---
 .../{update-pr.yaml => release-please.yaml}   |  4 +-
 README.md                                     | 38 +++++++++++++++++++
 2 files changed, 40 insertions(+), 2 deletions(-)
 rename .github/workflows/{update-pr.yaml => release-please.yaml} (71%)

diff --git a/.github/workflows/update-pr.yaml b/.github/workflows/release-please.yaml
similarity index 71%
rename from .github/workflows/update-pr.yaml
rename to .github/workflows/release-please.yaml
index 424fcfe..0747658 100644
--- a/.github/workflows/update-pr.yaml
+++ b/.github/workflows/release-please.yaml
@@ -4,10 +4,10 @@ on:
       - master
 name: coverage
 jobs:
-  update-pr:
+  release-please:
     runs-on: ubuntu-latest
     steps:
-      - uses: bcoe/release-please-action@9291b92aca4939d0cc2781f26504c638ce1ba534
+      - uses: bcoe/release-please-action@v1.0.1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           release-type: node
diff --git a/README.md b/README.md
index 27478cb..8815f12 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
 # Release Please Action
 
 Automate releases based on Conventional Commit Messages.
+
+## How release please works
+
+### How should I write my commits?
+
+### What's a release PR?
+
+## Configuring this action
+
+1. If you haven't already done so, create a `.github/workflows` folder in your
+  repository (_this is where your actions will live_).
+2. Now create a `.github/workflows/release-please.yml` file with these contents:
+
+   ```yaml
+    on:
+      push:
+        branches:
+          - master
+    name: coverage
+    jobs:
+      release-please:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: bcoe/release-please-action@9291b92aca4939d0cc2781f26504c638ce1ba534
+            with:
+              token: ${{ secrets.GITHUB_TOKEN }}
+              release-type: node
+              package-name: release-please-action
+    ```
+
+3. Merge the above action into your repository and make sure new commits follow
+  the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+  convention, [release-please](https://github.com/googleapis/release-please)
+  will start creating Release PRs for you.
+
+## License
+
+Apache Version 2.0