⌨️ Readme Typing SVG

📃 Table of contents

• 📃 Table of contents
• ⚡ Quick setup
• ⚙ Demo site
• 🚀 Example usage
• 🔧 Options
• 📤 Deploying it on your own
• 🤗 Contributing
  • Installing requirements
    • Requirements
    • Linux
    • Windows
  • Clone the repository
  • Running the app locally
  • Running the tests
• 🙋‍♂️ Support

⚡ Quick setup

1. Copy-paste the markdown below into your GitHub profile README
2. Replace the value after ?lines= with your text. Separate lines of text with semicolons and use + or %20 for spaces.
3. (Optional) Adjust the width parameter (see below) to fit the full width of your text.

[![Typing SVG](https://readme-typing-svg.herokuapp.com/?lines=First+line+of+text;Second+line+of+text)](https://git.io/typing-svg)

⚙ Demo site

Here you can easily customize your Typing SVG with a live preview.

https://readme-typing-svg.herokuapp.com/demo/

🚀 Example usage

• Jonah Lawrence
• Waren Gonzaga
• Eke Victor
• 8BitJonny
• Krish
• Aditya Raute
• Shiva Sankeerth Reddy

Feel free to open a PR and add yours!

🔧 Options

Parameter	Details	Type	Example
lines	Text to display with lines separated by ; and + for spaces	string	First+line;Second+line;Third+line
center	true to center text or false for left aligned (default: false)	boolean	true or false
vCenter	true to center vertically or false(default) to align above the center	boolean	true or false
height	Height of the output SVG in pixels (default: 50)	integer	Any positive number
width	Width of the output SVG in pixels (default: 400)	integer	Any positive number
font	Font family (default: monospace)	string	Any font from Google Fonts
size	Font size in pixels (default: 20)	integer	Any positive number
color	Color of the text (default: 36BCF7)	string	Hex code without # (eg. 00ff00)
multiline	true to wrap lines or false to retype on one line (default: false)	boolean	true or false

📤 Deploying it on your own

If you can, it is preferable to host the files on your own server.

Doing this can lead to better uptime and more control over customization (you can modify the code for your usage).

You can deploy the PHP files on any website server with PHP installed or as a Heroku app.

🤗 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

Installing requirements

Requirements

• PHP 7
• Composer

Linux

sudo apt-get install php
sudo apt-get install php-curl
sudo apt-get install composer

Windows

Install PHP from XAMPP or php.net

▶ How to install and run PHP using XAMPP (Windows)

📥 Download Composer

Clone the repository

git clone https://github.com/DenverCoder1/readme-typing-svg.git
cd readme-typing-svg

Running the app locally

composer start

Open http://localhost:8000/ and add parameters to run the project locally.

Running the tests

Before you can run tests, PHPUnit must be installed. You can install it using Composer by running the following command.

composer install

Run the following command to run the PHPUnit test script which will verify that the tested functionality is still working.

composer test

🙋‍♂️ Support

💙 If you like this project, give it a ⭐ and share it with friends!

☕ Buy me a coffee

---

Made with ❤️ and PHP