# Emojis

(🚧 work in progress 🚧)

Emojis are a fun way to add some personality to your README.md file. README-AI allows you to automatically add emojis to all headers in the generated README file by providing the `--emojis` option to the `readmeai` command.

## How It Works

When you provide the `--emojis` option to the `readmeai` command, README-AI automatically adds emojis to all headers in the generated README file.

=== "Emojis Enabled"

    (🚧 work in progress 🚧)

=== "Emojis Disabled (default)"

    (🚧 work in progress 🚧)

## Usage

To enable emojis in the generated README file, use the `--emojis` option when running the `readmeai` command:

```sh
readmeai --repository <your-repo-url> --emojis
```

---
