Skip to content
briefcase

GitHub Action

GitHub Readme Showwcase Cards

v1.3.0 Latest version

GitHub Readme Showwcase Cards

briefcase

GitHub Readme Showwcase Cards

Workflow for displaying your Showwcase profile as an SVG

Installation

Copy and paste the following snippet into your .yml file.

              

- name: GitHub Readme Showwcase Cards

uses: sahil-sagwekar2652/[email protected]

Learn more about this action in sahil-sagwekar2652/github-readme-showwcase-cards

Choose a version

Showwcase Readme Cards

How to Use

  1. Add the following code to your README.md file.
<!-- BEGIN SHOWWCASE_PROFILE>
<!-- END SHOWWCASE_PROFILE>
  1. Get the Showwcase API key from here.

  2. Add the API key as a GitHub secret with the name SHOWWCASE_API_KEY. You can do this by going to Settings > Secrets and clicking on New repository secret. Here is a video tutorial on how to do this.

  3. Add a new workflow in the .github folder. You can do this by going to .github/workflows and clicking on New file and add the following code to it. Replace your username in the above code and commit the file.

name: Showwcase Profile Card
on:
  schedule:
    # Runs every day at 12:00
    - cron: "0 12 * * *"
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: sahil-sagwekar2652/github-readme-showwcase-cards@main
        id: showwcase-cards
        with: 
          api_key: ${{ secrets.SHOWWCASE_API_KEY }}
          theme: "dark"
          username: <your showwcase username>

Example

sahil-sagwekar2652