Skip to content

Commit d9bb932

Browse files
committed
docs: Tweak README
1 parent d1ecf62 commit d9bb932

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<img alt="Conductor logo" src="https://github.com/conductor-is/quickbooks-desktop-api/assets/170023/d67464b8-53a7-4d33-afeb-05a2efde1fa8" width="325">
77
</picture>
88
</a>
9-
<h3>QuickBooks Desktop/Enterprise real-time API for Python, Node.js, and REST</h3>
9+
<h3>QuickBooks Desktop/Enterprise real-time API for Node.js, Python, and REST</h3>
1010
<a href="https://docs.conductor.is/quickstart">Quickstart</a>
1111
<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
1212
<a href="https://conductor.is">Website</a>
@@ -17,7 +17,7 @@
1717
<br />
1818
<br />
1919
<a href="https://npmjs.com/package/conductor-node"><img src="https://img.shields.io/npm/dm/conductor-node.svg?logo=npm" alt="NPM download count"></a>
20-
<a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/npm/v/conductor-node.svg?logo=npm" alt="Package version"></a>
20+
<a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/npm/v/conductor-node.svg?logo=npm" alt="NPM version"></a>
2121
<a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/bundlephobia/minzip/conductor-node" alt="NPM bundle size"></a>
2222
<img src="https://img.shields.io/badge/coverage-100%25-brightgreen" alt="Code coverage">
2323
<a href="LICENSE"><img src="https://img.shields.io/npm/l/conductor-node.svg?color=blue&logo=github" alt="License" /></a>
@@ -28,18 +28,23 @@
2828

2929
**Follow our [Quickstart guide](https://docs.conductor.is/quickstart) to get started.**
3030

31-
This repository is for the Node.js (TypeScript/JavaScript) library. For Python, see [conductor-python](https://github.com/conductor-is/quickbooks-desktop-python).
31+
This repository contains the official Conductor **Node.js** library, which provides convenient access to our QuickBooks Desktop API from any server-side TypeScript or JavaScript application.
32+
33+
- For Python, see [conductor-python](https://github.com/conductor-is/quickbooks-desktop-python).
34+
35+
## Documentation
36+
37+
The REST API documentation can be found on [docs.conductor.is](https://docs.conductor.is/qbd-api). The full API of this library can be found in [api.md](api.md).
3238

3339
## Installation
3440

3541
```sh
3642
npm install conductor-node@beta
3743
```
3844

39-
This version of the library is in beta, but it **_is_ stable and ready for production use**. We merely have a few more endpoints to migrate before prompting all existing users to update.
40-
41-
> [!NOTE]
42-
> If migrating from the old `conductor-node` package, see the [migration guide](https://docs.conductor.is/qbd-api/upgrade-node).
45+
> **Note:** Though this version of the Node.js SDK uses an NPM `@beta` tag, it **_is_ stable and ready for production use**! We merely have a few more endpoints to migrate before prompting all existing users to update. **Any new Conductor users should absolutely use the beta version**!
46+
>
47+
> If you're migrating from the old `conductor-node` package, see the [migration guide](https://docs.conductor.is/qbd-api/upgrade-node).
4348
4449
## Key features
4550

0 commit comments

Comments
 (0)