Skip to content

Commit 8b27bf1

Browse files
committed
docs: polish readme for docs site
1 parent 0cc3020 commit 8b27bf1

3 files changed

Lines changed: 170 additions & 30 deletions

File tree

.github/assets/readme-hero.svg

Lines changed: 90 additions & 0 deletions
Loading

README.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
1+
<p align="center">
2+
<a href="https://csfloat-node-sdk.vercel.app">
3+
<img src="https://raw.githubusercontent.com/Krablante/csfloat-node-sdk/main/.github/assets/readme-hero.svg" alt="csfloat-node-sdk" width="100%" />
4+
</a>
5+
</p>
6+
17
# csfloat-node-sdk
28

39
[![npm version](https://img.shields.io/npm/v/csfloat-node-sdk?logo=npm&label=npm)](https://www.npmjs.com/package/csfloat-node-sdk)
10+
[![Docs Site](https://img.shields.io/badge/docs-site-C6973A?logo=vercel&logoColor=white)](https://csfloat-node-sdk.vercel.app)
411
[![CI](https://github.com/Krablante/csfloat-node-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/Krablante/csfloat-node-sdk/actions/workflows/ci.yml)
512
[![TypeScript](https://img.shields.io/badge/TypeScript-first-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
613
[![Live API Audit](https://img.shields.io/badge/live%20API-audited-1f883d)](./scripts/live-api-audit.mjs)
714
[![Coverage Matrix](https://img.shields.io/badge/API%20coverage-matrix-0a7ea4)](./API_COVERAGE.md)
815
[![License: MIT](https://img.shields.io/github/license/Krablante/csfloat-node-sdk)](./LICENSE)
916
[![Issues](https://img.shields.io/github/issues/Krablante/csfloat-node-sdk)](https://github.com/Krablante/csfloat-node-sdk/issues)
1017

11-
The strongest public Node.js / TypeScript SDK for the **currently known** CSFloat surface that we can responsibly validate today.
18+
<p align="center">
19+
<a href="https://csfloat-node-sdk.vercel.app"><strong>Docs Site</strong></a>
20+
·
21+
<a href="https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/README.md"><strong>Docs Hub</strong></a>
22+
·
23+
<a href="https://www.npmjs.com/package/csfloat-node-sdk"><strong>npm</strong></a>
24+
·
25+
<a href="https://github.com/Krablante/csfloat-node-sdk/blob/main/API_COVERAGE.md"><strong>Coverage Matrix</strong></a>
26+
</p>
27+
28+
Live-validated Node.js / TypeScript SDK for the **currently known** CSFloat surface: market reads, listings, account routes, offers, trades, buy orders, companion/loadout flows, and a maintained coverage matrix.
1229

1330
`csfloat-node-sdk` is built to do two things well at the same time:
1431

@@ -23,23 +40,31 @@ The project is intentionally conservative about claims. Anything called `impleme
2340
2441
## Documentation
2542

26-
The docs set now aims to cover the full public runtime surface of the package, not just the quick-start path.
43+
Primary docs site:
44+
45+
- [`https://csfloat-node-sdk.vercel.app`](https://csfloat-node-sdk.vercel.app)
46+
47+
The repository docs and the docs site are kept in sync from the same Markdown source, and the `docs/` set still ships in the npm tarball.
2748

2849
If you want the fastest path through the SDK, start here:
2950

30-
1. [Documentation Hub](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/README.md)
31-
2. [Getting Started](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/getting-started.md)
32-
3. [Resources, Workflows, And Surface Map](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/resources-and-workflows.md)
33-
4. [Resource Reference](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/resource-reference.md)
34-
5. [Helpers, Builders, And Constants](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/helpers-and-builders.md)
35-
6. [Write Flows And Payloads](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/write-flows-and-payloads.md)
36-
7. [Workflows And CLI](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/workflows-and-cli.md)
37-
8. [Transport, Errors, And Metadata](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/transport-and-errors.md)
38-
9. [Examples And Recipes](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/examples-and-recipes.md)
39-
10. [Stability And Coverage](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/stability-and-coverage.md)
40-
11. [API Coverage Matrix](https://github.com/Krablante/csfloat-node-sdk/blob/main/API_COVERAGE.md)
41-
42-
These Markdown docs ship in the npm tarball as well, so npm users are not forced onto a separate site just to understand the SDK.
51+
1. [Docs Site Home](https://csfloat-node-sdk.vercel.app)
52+
2. [Documentation Hub](https://csfloat-node-sdk.vercel.app/docs)
53+
3. [Getting Started](https://csfloat-node-sdk.vercel.app/docs/getting-started)
54+
4. [Resource Reference](https://csfloat-node-sdk.vercel.app/docs/resource-reference)
55+
5. [Write Flows And Payloads](https://csfloat-node-sdk.vercel.app/docs/write-flows-and-payloads)
56+
6. [Helpers, Builders, And Constants](https://csfloat-node-sdk.vercel.app/docs/helpers-and-builders)
57+
7. [Workflows And CLI](https://csfloat-node-sdk.vercel.app/docs/workflows-and-cli)
58+
8. [Transport, Errors, And Metadata](https://csfloat-node-sdk.vercel.app/docs/transport-and-errors)
59+
9. [Examples And Recipes](https://csfloat-node-sdk.vercel.app/docs/examples-and-recipes)
60+
10. [Stability And Coverage](https://csfloat-node-sdk.vercel.app/docs/stability-and-coverage)
61+
11. [API Coverage Matrix](https://csfloat-node-sdk.vercel.app/docs/api-coverage)
62+
63+
GitHub-first entrypoints remain available too:
64+
65+
1. [Repository docs/ hub](https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/README.md)
66+
2. [Repository API_COVERAGE.md](https://github.com/Krablante/csfloat-node-sdk/blob/main/API_COVERAGE.md)
67+
3. [Repository CHANGELOG.md](https://github.com/Krablante/csfloat-node-sdk/blob/main/CHANGELOG.md)
4368

4469
## Why Choose This SDK
4570

website/content/package-readme.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
1+
<p align="center">
2+
<a href="https://csfloat-node-sdk.vercel.app">
3+
<img src="https://raw.githubusercontent.com/Krablante/csfloat-node-sdk/main/.github/assets/readme-hero.svg" alt="csfloat-node-sdk" width="100%" />
4+
</a>
5+
</p>
6+
17
# csfloat-node-sdk
28

39
[![npm version](https://img.shields.io/npm/v/csfloat-node-sdk?logo=npm&label=npm)](https://www.npmjs.com/package/csfloat-node-sdk)
10+
[![Docs Site](https://img.shields.io/badge/docs-site-C6973A?logo=vercel&logoColor=white)](https://csfloat-node-sdk.vercel.app)
411
[![CI](https://github.com/Krablante/csfloat-node-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/Krablante/csfloat-node-sdk/actions/workflows/ci.yml)
512
[![TypeScript](https://img.shields.io/badge/TypeScript-first-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
613
[![Live API Audit](https://img.shields.io/badge/live%20API-audited-1f883d)](https://github.com/Krablante/csfloat-node-sdk/blob/main/scripts/live-api-audit.mjs)
714
[![Coverage Matrix](https://img.shields.io/badge/API%20coverage-matrix-0a7ea4)](/docs/api-coverage)
815
[![License: MIT](https://img.shields.io/github/license/Krablante/csfloat-node-sdk)](https://github.com/Krablante/csfloat-node-sdk/blob/main/LICENSE)
916
[![Issues](https://img.shields.io/github/issues/Krablante/csfloat-node-sdk)](https://github.com/Krablante/csfloat-node-sdk/issues)
1017

11-
The strongest public Node.js / TypeScript SDK for the **currently known** CSFloat surface that we can responsibly validate today.
18+
<p align="center">
19+
<a href="https://csfloat-node-sdk.vercel.app"><strong>Docs Site</strong></a>
20+
·
21+
<a href="https://github.com/Krablante/csfloat-node-sdk/blob/main/docs/README.md"><strong>Docs Hub</strong></a>
22+
·
23+
<a href="https://www.npmjs.com/package/csfloat-node-sdk"><strong>npm</strong></a>
24+
·
25+
<a href="https://github.com/Krablante/csfloat-node-sdk/blob/main/API_COVERAGE.md"><strong>Coverage Matrix</strong></a>
26+
</p>
27+
28+
Live-validated Node.js / TypeScript SDK for the **currently known** CSFloat surface: market reads, listings, account routes, offers, trades, buy orders, companion/loadout flows, and a maintained coverage matrix.
1229

1330
`csfloat-node-sdk` is built to do two things well at the same time:
1431

@@ -23,23 +40,31 @@ The project is intentionally conservative about claims. Anything called `impleme
2340
2441
## Documentation
2542

26-
The docs set now aims to cover the full public runtime surface of the package, not just the quick-start path.
43+
Primary docs site:
44+
45+
- [`https://csfloat-node-sdk.vercel.app`](https://csfloat-node-sdk.vercel.app)
46+
47+
The repository docs and the docs site are kept in sync from the same Markdown source, and the `docs/` set still ships in the npm tarball.
2748

2849
If you want the fastest path through the SDK, start here:
2950

30-
1. [Documentation Hub](/docs)
31-
2. [Getting Started](/docs/getting-started)
32-
3. [Resources, Workflows, And Surface Map](/docs/resources-and-workflows)
33-
4. [Resource Reference](/docs/resource-reference)
34-
5. [Helpers, Builders, And Constants](/docs/helpers-and-builders)
35-
6. [Write Flows And Payloads](/docs/write-flows-and-payloads)
36-
7. [Workflows And CLI](/docs/workflows-and-cli)
37-
8. [Transport, Errors, And Metadata](/docs/transport-and-errors)
38-
9. [Examples And Recipes](/docs/examples-and-recipes)
39-
10. [Stability And Coverage](/docs/stability-and-coverage)
40-
11. [API Coverage Matrix](/docs/api-coverage)
41-
42-
These Markdown docs ship in the npm tarball as well, so npm users are not forced onto a separate site just to understand the SDK.
51+
1. [Docs Site Home](https://csfloat-node-sdk.vercel.app)
52+
2. [Documentation Hub](https://csfloat-node-sdk.vercel.app/docs)
53+
3. [Getting Started](https://csfloat-node-sdk.vercel.app/docs/getting-started)
54+
4. [Resource Reference](https://csfloat-node-sdk.vercel.app/docs/resource-reference)
55+
5. [Write Flows And Payloads](https://csfloat-node-sdk.vercel.app/docs/write-flows-and-payloads)
56+
6. [Helpers, Builders, And Constants](https://csfloat-node-sdk.vercel.app/docs/helpers-and-builders)
57+
7. [Workflows And CLI](https://csfloat-node-sdk.vercel.app/docs/workflows-and-cli)
58+
8. [Transport, Errors, And Metadata](https://csfloat-node-sdk.vercel.app/docs/transport-and-errors)
59+
9. [Examples And Recipes](https://csfloat-node-sdk.vercel.app/docs/examples-and-recipes)
60+
10. [Stability And Coverage](https://csfloat-node-sdk.vercel.app/docs/stability-and-coverage)
61+
11. [API Coverage Matrix](https://csfloat-node-sdk.vercel.app/docs/api-coverage)
62+
63+
GitHub-first entrypoints remain available too:
64+
65+
1. [Repository docs/ hub](/docs)
66+
2. [Repository API_COVERAGE.md](/docs/api-coverage)
67+
3. [Repository CHANGELOG.md](/docs/changelog)
4368

4469
## Why Choose This SDK
4570

0 commit comments

Comments
 (0)