readme-template's Introduction

This repo is a guide for myself on how to setup Dynamic Readme, but if you are interested in doing something similar feel free to take a look

JaxCore ReadME-Template

Uses Dynamic Readme github action.

Use template in module repo

Create a workflow file Dynamic-Readme.yml with the following contents

name: "📄  Dynamic ReadME"

env:
  VS_WORKFLOW_TYPE: "dynamic-readme"

on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - README.md

jobs:
  update_readme:
    name: "Render & Update ReadME"
    runs-on: ubuntu-latest
    steps:
      - name: "📥  Fetching Repository Contents"
        uses: actions/checkout@main

      - name: "💾  Github Repository Metadata"
        uses: varunsridharan/action-repository-meta@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: "💫  Update README.md"
        uses: "varunsridharan/action-dynamic-readme@main"
        with:
          GLOBAL_TEMPLATE_REPOSITORY: Jax-Core/ReadME-Template/Templates
          commit_message: ⏩ File Rebuilt by Github Actions - Dynamic ReadME
          files: |
            README.md
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Creating ReadME

Create README.md with the following contents

<!-- START Header.mustache -->
<!-- END Header.mustache -->
<!-- START ShieldsFull.mustache -->
<!-- END ShieldsFull.mustache -->
<!-- ShieldsBasic for shields without download count and last update date--> 

<!-- START About.mustache -->
<!-- END About.mustache -->
Long description goes here

<!-- START Features.mustache -->
<!-- END Features.mustache -->
* Bulleted features list goes here

<!-- START GetStarted.mustache -->
<!-- END GetStarted.mustache -->
<!-- START Setup.mustache -->
<!-- END Setup.mustache -->
<!-- START Footer.mustache -->
<!-- END Footer.mustache -->

Recommend Projects