docs(quickstart): Usage documentation #36 #43

Author: eddiejaoude

.github/workflows/community.yml

@@ -12,6 +12,7 @@ on:
     types: [ created ]
 
 jobs:
+
   welcome:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -1,9 +1,45 @@
 # GitHub Action Community <img src="https://i.imgur.com/m6EYre1.png" width="50px">
 
-GitHub Action for the Community - from welcoming first timers to badges!
+GitHub Action for the Community - from welcoming first timers to logging your activity for badges!
 
-## Features 💡
+## GitHub Action Features 💡
 
-- Replies to new Issues and Pull Requests
-- Logs statistics of user activity
+These GitHub Actions will:
+- reply to all new **Issues** and **Pull Requests**
+- log statistics of user activity to Firestore DB (Firebase)
 
+## Quickstart
+
+You can use 1 or all of these GitHub Actions.
+
+### Welcoming message
+
+This GitHub Action will reply to all new **Issues** and **Pull Requests** with a custom message
+
+Example usage (you can change the replies for `issue-message` and `pr-message`)
+```yaml
+  welcome:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: EddieJaoudeCommunity/gh-action-community/src/welcome@main
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-message: '<h1>It''s great having you contribute to this project</h1> Feel free to raise an <strong>Issue</strong>! Welcome to the community :nerd_face:'
+          pr-message: '<h1>It''s great having you contribute to this project</h1> Feel free to create a <strong>Pull Request</strong>! Welcome to the community :nerd_face:'
+```
+
+### Store community acitivity
+
+This GitHub Action will log statistics of user activity to Firestore DB (Firebase)
+
+```yaml
+  statistics:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: EddieJaoudeCommunity/gh-action-community/src/statistics@main
+        if: ${{ <expression> }}
+        with:
+          firebase-key: ${{ secrets.FIREBASE_KEY }}
+```