From ac05eefe6ad25ca635cb6d0e1b31b46bad20c715 Mon Sep 17 00:00:00 2001 From: Sergii Solonyna Date: Mon, 9 Feb 2026 13:46:36 +0200 Subject: [PATCH] docs: update README with additional badges for API key, documentation, Postman collection, TypeScript, and Prettier --- .changeset/add-readme-badges.md | 5 +++++ README.md | 6 ++++++ commitlint.config.js | 2 +- 3 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .changeset/add-readme-badges.md diff --git a/.changeset/add-readme-badges.md b/.changeset/add-readme-badges.md new file mode 100644 index 0000000..19b89b1 --- /dev/null +++ b/.changeset/add-readme-badges.md @@ -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) diff --git a/README.md b/README.md index 9f755c5..e1263da 100644 --- a/README.md +++ b/README.md @@ -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) + [![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)]() +[![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`. diff --git a/commitlint.config.js b/commitlint.config.js index 8c2747a..a16b8cf 100644 --- a/commitlint.config.js +++ b/commitlint.config.js @@ -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], 'body-max-line-length': [0, 'always', Infinity], }, };