Skip to content

Replace root README with exact badge-rich BasicMails template - #1

Merged
benjamin-blanke merged 1 commit into
mainfrom
copilot/update-readme-for-basicmails
Sep 16, 2026
Merged

benjamin-blanke merged 1 commit into
mainfrom
copilot/update-readme-for-basicmails

Conversation

Copilot AI commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

This PR replaces the repository-root README.md with the exact markdown requested in the issue, including the specified badge format and copy-ready project documentation. The goal is to provide a polished, consistent landing page aligned with the previously approved content.

  • Scope

    • Replaced /README.md content in full to match the provided template exactly.
    • Preserved all required formatting details: badge URLs, heading structure, horizontal rules, code fences, and inline examples.
  • README content updates

    • Added top-level badge block using <img> tags for release, license, language, stars, and issues.
    • Included structured sections: Why BasicMails, Features, Quick Start, Configuration, Development, Contributing, Security, License, Contact.
    • Included the exact Table of Contents format and example snippets as provided.
  • Example included in README

    import { BasicMailsClient } from 'basicmails'
    
    const client = new BasicMailsClient({ apiKey: process.env.BASICMAILS_API_KEY })
    await client.send({
      to: 'friend@example.com',
      from: 'you@basicmails.local',
      subject: 'Hello from BasicMails',
      text: 'This is a quick test email.'
    })

Copilot AI changed the title [WIP] Add polished README.md for BasicMails Replace root README with exact badge-rich BasicMails template Sep 16, 2026
@benjamin-blanke
benjamin-blanke marked this pull request as ready for review September 16, 2026 07:25
@benjamin-blanke
benjamin-blanke merged commit 963cbe8 into main Sep 16, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants