Examples - Waveify Documentation

Examples & Use Cases

Real-world examples showing how to combine different Waveify APIs to create stunning GitHub README files and project documentation.

Full Stack Web App

Complete README header for a full-stack application

Complete Example

Live Preview:

Complete Markdown Code:

![Header](https://waveify.onrender.com/api/wave?color=%23667eea&height=150&speed=3&amplitude=25)

![Title](https://waveify.onrender.com/api/typing?text=TaskFlow+-+Project+Management+Made+Easy&speed=60&fontSize=28&style=gradient)

<div align="center">

![Build Status](https://waveify.onrender.com/api/loader?type=pulse&color=green&text=Build%20Passing)
![Version](https://waveify.onrender.com/api/terminal?text=Version:%20v2.1.0&style=modern&color=blue)
![License](https://waveify.onrender.com/api/terminal?text=License:%20MIT&style=modern&color=yellow)
![Coverage](https://waveify.onrender.com/api/loader?type=bars&color=green&text=Coverage:%2098%)

</div>

Open Source Library

Perfect setup for an NPM package or library

Complete Example

Live Preview:

Complete Markdown Code:

![Title](https://waveify.onrender.com/api/typing?text=AWESOME+LIBRARY&speed=100&color=%2300ff88&fontSize=32&style=neon)

![Divider](https://waveify.onrender.com/api/wave?color=%2300ff88&height=120&speed=2&amplitude=20)

## Installation

![Install](https://waveify.onrender.com/api/typing?text=npm+install+awesome-library&style=terminal&speed=80)

<div align="center">

![NPM](https://waveify.onrender.com/api/loader?type=orbit&color=red&text=NPM%20v1.5.2)
![Downloads](https://waveify.onrender.com/api/terminal?text=Downloads:%20125K&style=modern&color=blue)
![Size](https://waveify.onrender.com/api/terminal?text=Size:%2012KB&style=modern&color=green)

</div>

Cybersecurity Project

Dark theme setup for security-related projects

Complete Example

Live Preview:

Complete Markdown Code:

![Title](https://waveify.onrender.com/api/typing?text=CYBER+SECURITY+TOOLKIT&speed=70&color=%23ff0040&fontSize=30&style=glitch)

![Divider](https://waveify.onrender.com/api/wave?color=%23ff0040&height=140&speed=1&amplitude=30&style=glitch)

## Features

![Terminal](https://waveify.onrender.com/api/terminal?text=sudo+python3+security_scan.py+--target+localhost&style=matrix&speed=90)

<div align="center">

![Security](https://waveify.onrender.com/api/loader?type=grid&color=red&text=Security%20Verified)
![Status](https://waveify.onrender.com/api/terminal?text=Status:%20Active&style=modern&color=green)
![Tools](https://waveify.onrender.com/api/terminal?text=Tools:%2050+&style=modern&color=purple)

</div>

Markdown Tips

Best practices for embedding Waveify in markdown

Center alignment

Wrap images in `<div align="center">` tags for centering

Alt text

Always include descriptive alt text for accessibility

Spacing

Add empty lines between different sections for better readability

External Resources

Helpful links and tools

GitHub Markdown Guide

Official GitHub markdown documentation

Markdown Editors

Typora, Mark Text, or VS Code for live preview

Color Picker

Use browser dev tools or online color pickers

🚀 Share Your Creations

Created something amazing with Waveify? We'd love to see it! Share your projects with the community and inspire others to create beautiful README files.

Share on GitHub Discussions