Skip to content

Comments

docs: update README with additional badges for API key, documentation, Postman collection, TypeScript, and Prettier#1

Merged
serslon merged 1 commit intomasterfrom
fix/readme
Feb 9, 2026
Merged

docs: update README with additional badges for API key, documentation, Postman collection, TypeScript, and Prettier#1
serslon merged 1 commit intomasterfrom
fix/readme

Conversation

@serslon
Copy link
Collaborator

@serslon serslon commented Feb 9, 2026

No description provided.

…, Postman collection, TypeScript, and Prettier
Copilot AI review requested due to automatic review settings February 9, 2026 11:46
@serslon serslon merged commit d1e596e into master Feb 9, 2026
6 checks passed
@serslon serslon deleted the fix/readme branch February 9, 2026 11:47
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates repository/package presentation by adding additional README badges and recording the change via Changesets, while also adjusting commitlint’s maximum header length.

Changes:

  • Add promotional/technical badges to README.md (API key, docs, Postman, TypeScript, Prettier).
  • Add a patch changeset describing the README badge update.
  • Increase commitlint header-max-length from 100 to 255.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
commitlint.config.js Loosens commit message header length limit (100 → 255).
README.md Adds new badges for API key/docs/Postman/TypeScript/Prettier.
.changeset/add-readme-badges.md Records the README badge update as a patch release entry.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +3 to +5
[![Get API Key](https://img.shields.io/badge/Get%20API%20Key-6C63FF?style=for-the-badge&logoColor=white)](https://dashboard.astrology-api.io/)
[![API Documentation](https://img.shields.io/badge/API%20Documentation-FCC624?style=for-the-badge&logoColor=black)](https://api.astrology-api.io/rapidoc)
[![Postman Collection](https://img.shields.io/badge/Postman%20Collection-FF6C37?style=for-the-badge&logo=postman&logoColor=white)](https://api.astrology-api.io/best-astrology-api-postman.json)
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Badge styling is currently mixed: the new badges use style=for-the-badge while the existing CI/npm/license badges use the default shields style. Consider using a consistent shields style across all badges (either remove style=for-the-badge from the new ones or apply it to the existing ones) to avoid inconsistent sizing/visual layout.

Suggested change
[![Get API Key](https://img.shields.io/badge/Get%20API%20Key-6C63FF?style=for-the-badge&logoColor=white)](https://dashboard.astrology-api.io/)
[![API Documentation](https://img.shields.io/badge/API%20Documentation-FCC624?style=for-the-badge&logoColor=black)](https://api.astrology-api.io/rapidoc)
[![Postman Collection](https://img.shields.io/badge/Postman%20Collection-FF6C37?style=for-the-badge&logo=postman&logoColor=white)](https://api.astrology-api.io/best-astrology-api-postman.json)
[![Get API Key](https://img.shields.io/badge/Get%20API%20Key-6C63FF?logoColor=white)](https://dashboard.astrology-api.io/)
[![API Documentation](https://img.shields.io/badge/API%20Documentation-FCC624?logoColor=black)](https://api.astrology-api.io/rapidoc)
[![Postman Collection](https://img.shields.io/badge/Postman%20Collection-FF6C37?logo=postman&logoColor=white)](https://api.astrology-api.io/best-astrology-api-postman.json)

Copilot uses AI. Check for mistakes.
],
'subject-case': [2, 'never', ['start-case', 'pascal-case', 'upper-case']],
'header-max-length': [2, 'always', 100],
'header-max-length': [2, 'always', 255],
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR title indicates this is a docs/README-only change, but this modifies commitlint behavior by increasing header-max-length from 100 to 255. If this change is intentional, it should be called out in the PR description (with rationale); otherwise it should be reverted to avoid unexpectedly loosening commit message validation for the repo.

Copilot uses AI. Check for mistakes.
[![npm version](https://img.shields.io/npm/v/@astro-api/astroapi-typescript.svg)](https://www.npmjs.com/package/@astro-api/astroapi-typescript)
[![npm downloads](https://img.shields.io/npm/dm/@astro-api/astroapi-typescript.svg)](https://www.npmjs.com/package/@astro-api/astroapi-typescript)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue?logo=typescript&logoColor=white)]()
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This TypeScript badge uses an empty link target (), which renders as a non-functional link. Please either provide a valid URL (e.g., TypeScript website/releases or repo) or remove the link wrapper if it’s meant to be non-clickable.

Suggested change
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue?logo=typescript&logoColor=white)]()
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)

Copilot uses AI. Check for mistakes.
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.

1 participant