Skip to content

Commit

Permalink
docs: refine README text
Browse files Browse the repository at this point in the history
Simplified the text to make it more concise and polished, reducing overly technical or developer-centric phrasing.
  • Loading branch information
matrei committed Jan 9, 2025
1 parent 8ca7196 commit 8fed130
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
[![Maven Central](https://img.shields.io/maven-central/v/org.grails.plugins/mail.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/org.grails.plugins/mail)
[![Java CI](https://github.com/gpc/grails-mail/actions/workflows/gradle.yml/badge.svg?event=push)](https://github.com/gpc/grails-mail/actions/workflows/gradle.yml)

The Grails Mail Plugin provides a convenient DSL (Domain Specific Language) for _sending_ email. It supports plain text, html, attachments, inline resources and i18n among other features.
The Grails Mail Plugin provides a convenient Domain-Specific Language (DSL) for _sending_ email, supporting features such as plain text, HTML, attachments, inline resources and i18n (internationalization), among others.

Mail can be sent using the `mailService.sendMail` method. Here is an example:
Email can be sent using the `mailService.sendMail` method. Here's an example:
```groovy
mailService.sendMail {
to '[email protected]', '[email protected]'
Expand All @@ -19,7 +19,8 @@ mailService.sendMail {

## Documentation

[Latest documentation](https://gpc.github.io/grails-mail/latest/) and [snapshots](https://gpc.github.io/grails-mail/snapshot/) are available.
- [Latest Release](https://gpc.github.io/grails-mail/latest/)
- [Development Snapshot](https://gpc.github.io/grails-mail/snapshot/)

## Versions

Expand All @@ -37,6 +38,6 @@ Issues can be raised via [GitHub Issues](https://github.com/gpc/grails-mail/issu

## Contributing

Pull requests are the preferred method for submitting contributions. Please open an issue via that issue tracker link above and create an issue describing what your contribution addresses.
Pull requests are the preferred way to submit contributions. Before submitting, please create an issue using the [issue tracker](https://github.com/gpc/grails-mail/issues), outlining the problem your contribution addresses.

If you are contributing documentation, raising an issue is not necessary.
For documentation contributions, creating an issue is not required.

0 comments on commit 8fed130

Please sign in to comment.