DEVOPS-62 updated readme

Author: githubofkrishnadhas

.github/workflows/github_billing_details.yaml

@@ -0,0 +1,38 @@
+name: github-automation-to-fetch-remaining-github-runner-time
+on:
+  schedule:
+    - cron: '0 0 * * 0' # weekly once
+  workflow_dispatch:
+    inputs:
+      organization:
+        description: 'GitHub organization name'
+        required: true
+        type: string
+        default: 'devwithkrishna'
+      account_name:
+        description: 'GitHub user account name'
+        default: 'githubofkrishnadhas'
+        type: string
+        required: true
+jobs:
+  github-automation-to-fetch-remaining-github-runner-time:
+    runs-on: ubuntu-latest
+    steps:
+      - name: git checkout
+        uses: actions/checkout@v4
+      - name: set up python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: package installations
+        run: |
+          pip install pipenv
+          pipenv install
+      - name: execute python program
+        env:
+          SENDGRID_API_KEY: ${{ secrets.SENDGRID_API_KEY }}
+        run: |
+          pipenv run python3 github_billing.py --organization ${{ inputs.organization }} --account_name ${{ inputs.account_name }}
+      - name: Completed
+        run: |
+          echo "program completed successfully"

README.md

@@ -3,3 +3,30 @@ An automation to pull github free runner time remaining for my account and mail
 
 ## Reference
 [get-github-actions-billing-for-an-organization](https://docs.github.com/en/rest/billing/billing?apiVersion=2022-11-28#get-github-actions-billing-for-an-organization)
+
+# What does this repo do
+
+```
+This repo uses github rest api to pull billing details for github org and user account. this iswritten to json files.
+Later these json files are dropped as an email using sendgrid to ownerof account. Email consists of multiple json atachments
+```
+
+# SendGrid 
+
+```
+SendGrid is a cloud-based service that provides email delivery and management for businesses. Sendgrid is used to send email
+using its python SDK - sendgrids
+```
+
+# parameters 
+
+| input name      | type | description                                            | required |
+|-----------------|------|--------------------------------------------------------|----------|
+| organization    | string | Github organizarion name. Default - `devwithkrishna`   | :heavy_check_mark: |
+| account_name    | string | GitHub account name. Default - `githubofkrishnadhas`   | :heavy_check_mark: |
+
+# Files
+* send_email.py --> sends a single file attachment with email
+* send_email_using_sendgrid.py --> sends multiple json files in a single email.
+* github_billing.py --> this will pull billing details using github rest api
+* email_template.html --> email html template