Deployment script to mirror your github readme into your personal web page!

Instruction.md

1. Create a github readme. To do it, create YourUsername repo.
2. In your repo, create ./github/workflows/website_mirror.yml and paste the content of the file below into it.
3. Go to its Settings -> Pages, select gh-pages as Source.
4. Create README.md in the root of the repo. Fill it with your info!
5. Done! Your personal web page is at yourusername.github.io/YourUsername.

website_mirror.yml

name: Website mirror

on:
  push:
    branches:
      - main

jobs:
  deployment:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
          
    - name: Rename readme to index
      run: mv README.md index.md
      
    - uses: JamesIves/github-pages-deploy-action@4.1.4
      name: gh-pages publish
      with:
        branch: gh-pages
        folder: .