From 8ca71969de1172d74cdf07e60f2c892e210b396f Mon Sep 17 00:00:00 2001 From: Mattias Reichel Date: Thu, 9 Jan 2025 10:25:31 +0100 Subject: [PATCH 1/2] docs: update README links to the correct GitHub repo Updated links in the README to point to the correct GitHub repository following the migration from the Grails GitHub organization. --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 080e635..329ce92 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ # Grails Mail Plugin [![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/grails/grails-mail/actions/workflows/gradle.yml/badge.svg?event=push)](https://github.com/grails/grails-mail/actions/workflows/gradle.yml) +[![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) -## About +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 DSL for _sending_ email. It supports plain text, html, attachments, inline resources and i18n among other features. - -Mail can be sent using the `mailService.sendMail` method. Here is an example… +Mail can be sent using the `mailService.sendMail` method. Here is an example: ```groovy mailService.sendMail { to 'fred@gmail.com', 'ginger@gmail.com' @@ -21,7 +19,7 @@ mailService.sendMail { ## Documentation -[Latest documentation](https://grails.github.io/grails-mail/latest/) and [snapshots](https://grails.github.io/grails-mail/snapshot/) are available. +[Latest documentation](https://gpc.github.io/grails-mail/latest/) and [snapshots](https://gpc.github.io/grails-mail/snapshot/) are available. ## Versions @@ -35,7 +33,7 @@ mailService.sendMail { ## Issues -Issues can be raised via [GitHub Issues](https://github.com/grails/grails-mail/issues). +Issues can be raised via [GitHub Issues](https://github.com/gpc/grails-mail/issues). ## Contributing From 8fed13001a28a70273519c620bdef95b7344b1aa Mon Sep 17 00:00:00 2001 From: Mattias Reichel Date: Thu, 9 Jan 2025 10:55:59 +0100 Subject: [PATCH 2/2] docs: refine README text Simplified the text to make it more concise and polished, reducing overly technical or developer-centric phrasing. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 329ce92..485954b 100644 --- a/README.md +++ b/README.md @@ -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 'fred@gmail.com', 'ginger@gmail.com' @@ -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 @@ -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.