Skip to content

Commit 6c211cf

Browse files
authored
chore: improve the api documentation and remove codecov in the pipeline and readme (#64)
Co-authored-by: Mr Stone <pierre.evens16@gmail.com>
1 parent b491761 commit 6c211cf

File tree

201 files changed

+2696
-3652
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

201 files changed

+2696
-3652
lines changed

.github/workflows/main.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ jobs:
2929
run: npm run test:cvg
3030
- name: Build library
3131
run: npm run build
32-
- name: Upload coverage reports to Codecov
33-
uses: codecov/codecov-action@v5
34-
with:
35-
token: ${{ secrets.CODECOV_TOKEN }}
36-
slug: stonemjs/http-core
3732
- name: SonarQube Scan
3833
uses: SonarSource/sonarqube-scan-action@v5
3934
env:

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,19 @@
44
[![npm](https://img.shields.io/npm/v/@stone-js/http-core)](https://www.npmjs.com/package/@stone-js/http-core)
55
[![npm](https://img.shields.io/npm/dm/@stone-js/http-core)](https://www.npmjs.com/package/@stone-js/http-core)
66
![Maintenance](https://img.shields.io/maintenance/yes/2025)
7-
[![Build Status](https://github.com/stonemjs/http-core/actions/workflows/main.yml/badge.svg)](https://github.com/stonemjs/http-core/actions/workflows/main.yml)
8-
[![Publish Package to npmjs](https://github.com/stonemjs/http-core/actions/workflows/release.yml/badge.svg)](https://github.com/stonemjs/http-core/actions/workflows/release.yml)
7+
[![Build Status (CI)](https://github.com/stonemjs/http-core/actions/workflows/main.yml/badge.svg)](https://github.com/stonemjs/http-core/actions/workflows/main.yml)
8+
[![Publish Package to npmjs (CD)](https://github.com/stonemjs/http-core/actions/workflows/release.yml/badge.svg)](https://github.com/stonemjs/http-core/actions/workflows/release.yml)
99
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=stonemjs_http-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=stonemjs_http-core)
10-
[![codecov](https://codecov.io/gh/stonemjs/http-core/graph/badge.svg?token=5MKS9179YL)](https://codecov.io/gh/stonemjs/http-core)
10+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=stonemjs_http-core&metric=coverage)](https://sonarcloud.io/summary/new_code?id=stonemjs_http-core)
1111
[![Security Policy](https://img.shields.io/badge/Security-Policy-blue.svg)](./SECURITY.md)
1212
[![CodeQL](https://github.com/stonemjs/http-core/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/stonemjs/http-core/security/code-scanning)
1313
[![Dependabot Status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg)](https://github.com/stonemjs/http-core/network/updates)
1414
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
1515

16+
Stone.js HTTP Core offers a simple, consistent API for handling HTTP requests and responses across any JavaScript runtime.
17+
18+
---
19+
1620
## Overview
1721

1822
The `@stone-js/http-core` package defines the foundational HTTP abstractions used throughout the Stone.js ecosystem. It introduces the `IncomingHttpEvent` and `OutgoingHttpResponse` classes, enabling context-aware handling of HTTP requests and responses in a runtime-agnostic way.
@@ -71,4 +75,3 @@ Explore the full documentation: https://stonejs.com
7175
## Contributing
7276

7377
See [Contributing Guide](https://github.com/stonemjs/http-core/blob/main/CONTRIBUTING.md)
74-

docs/BinaryFileResponse/README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
[**HTTP Core Documentation**](../README.md)
2-
3-
***
4-
5-
[HTTP Core Documentation](../README.md) / BinaryFileResponse
6-
71
# BinaryFileResponse
82

93
## Classes

0 commit comments

Comments
 (0)