Skip to content

Commit d1e596e

Browse files
authored
Merge pull request #1 from astro-api/fix/readme
docs: update README with additional badges for API key, documentation, Postman collection, TypeScript, and Prettier
2 parents 18be3ac + ac05eef commit d1e596e

3 files changed

Lines changed: 12 additions & 1 deletion

File tree

.changeset/add-readme-badges.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@astro-api/astroapi-typescript": patch
3+
---
4+
5+
Add promotional and technical badges to README (Get API Key, API Documentation, Postman Collection, TypeScript version, Prettier code style)

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
## Astrology API TypeScript SDK
22

3+
[![Get API Key](https://img.shields.io/badge/Get%20API%20Key-6C63FF?style=for-the-badge&logoColor=white)](https://dashboard.astrology-api.io/)
4+
[![API Documentation](https://img.shields.io/badge/API%20Documentation-FCC624?style=for-the-badge&logoColor=black)](https://api.astrology-api.io/rapidoc)
5+
[![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)
6+
37
[![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)
48
[![npm version](https://img.shields.io/npm/v/@astro-api/astroapi-typescript.svg)](https://www.npmjs.com/package/@astro-api/astroapi-typescript)
59
[![npm downloads](https://img.shields.io/npm/dm/@astro-api/astroapi-typescript.svg)](https://www.npmjs.com/package/@astro-api/astroapi-typescript)
610
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
11+
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue?logo=typescript&logoColor=white)]()
12+
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
713

814
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`.
915

commitlint.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default {
1919
],
2020
],
2121
'subject-case': [2, 'never', ['start-case', 'pascal-case', 'upper-case']],
22-
'header-max-length': [2, 'always', 100],
22+
'header-max-length': [2, 'always', 255],
2323
'body-max-line-length': [0, 'always', Infinity],
2424
},
2525
};

0 commit comments

Comments
 (0)