https://github.com/tonalmathew/readme-typing

Update your readme file with SVG typing texts.
https://github.com/tonalmathew/readme-typing

actions readme svg typing

Last synced: 4 days ago
JSON representation

Update your readme file with SVG typing texts.

• Host: GitHub
• URL: https://github.com/tonalmathew/readme-typing
• Owner: tonalmathew
• License: mit
• Created: 2023-08-13T13:06:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-25T08:09:19.000Z (over 1 year ago)
• Last Synced: 2025-01-18T00:40:31.703Z (6 days ago)
• Topics: actions, readme, svg, typing
• Language: JavaScript
• Homepage:
• Size: 583 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Typing - Readme SVG Text







Update your readme with SVG typing texts.


## Instructions

- Add this comment in your `README.md` file

  ```

   

  

  ``` 

  > you can find an example [here](https://github.com/tonalmathew/tonalmathew)

- Create a workflow file

  `.github/workflows/readme-typing.yml`

  ```yml

  name: Readme - svg text

  on:

    workflow_dispatch:

  jobs:

    update-readme:

      runs-on: ubuntu-latest

      steps:

      - name: Checkout code

        uses: actions/checkout@v3

      - name: Run the action

        uses: tonalmathew/readme-typing@main

        env:

          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

        with:

          INPUT_TEXT: |

            Hello, from svg typing.

            Add more text line by line.

  ```

- The above job won't run automatically, you need to run the job manually from the actions tab.

### Override defaults

Use the following input params to customize it for your use case:-

| Input Param       | Default Value                                         | Description                                               |

| ----------------- | ----------------------------------------------------- | --------------------------------------------------------- |

| `COMMITTER_NAME`  | github-actions[bot]                                   | Name of the committer                                     |

| `COMMITTER_EMAIL` | 41898282+github-actions[bot]@users.noreply.github.com | Email of the committer                                    |

| `COLOR`           | #36BCF7                                               | Color of the text                                         |

| `TEXT_ALIGN`      | start (available values: `start`, `center`)           | Align the svg text position                               |

_An alternative method for [DenverCoder1/readme-typing-svg](https://github.com/DenverCoder1/readme-typing-svg)_