Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/add-readme-badges.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@astro-api/astroapi-typescript": patch
---

Add promotional and technical badges to README (Get API Key, API Documentation, Postman Collection, TypeScript version, Prettier code style)
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
## Astrology API TypeScript SDK

[![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)
Comment on lines +3 to +5
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.

[![CI](https://github.com/astro-api/astroapi-typescript/actions/workflows/ci.yml/badge.svg)](https://github.com/astro-api/astroapi-typescript/actions/workflows/ci.yml)
[![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.
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Type-safe Node.js client for the [Astrology API v3.2.10](https://api.astrology-api.io/rapidoc). The package ships as an ESM build, exposes a modular architecture with dedicated sub-clients per endpoint family, and enforces 100 % test coverage. Publish-ready as `@astro-api/astroapi-typescript`.

Expand Down
2 changes: 1 addition & 1 deletion commitlint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export default {
],
],
'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.
'body-max-line-length': [0, 'always', Infinity],
},
};
Loading