From 90c678823a31212464aafa573cc6ba9e1a1b16e7 Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji Date: Thu, 4 Jul 2024 21:30:24 +0100 Subject: [PATCH 1/5] Update README.md --- README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 74 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bed7581..9086918 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,74 @@ -# apitoolkit-js -share code for all js web framework apitoolkit sdks +
+ +![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only) +![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only) + +## JS SDKs Shared Code + +[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=javascript)](https://github.com/topics/apitoolkit-sdk) [![](https://img.shields.io/npm/v/apitoolkit-js.svg?logo=npm)](https://npmjs.com/package/apitoolkit-js) [![](https://img.shields.io/npm/dw/apitoolkit-js +)](https://npmjs.com/package/apitoolkit-js) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://discord.gg/dEB6EjQnKB) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) + +APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) based on the framework your application is built with or directly use this `apitoolkit-js` package (the shared code for all the JS SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers. + +
+ +--- + +## Table of Contents + +- [Installation](#installation) +- [Configuration](#configuration) +- [Contributing and Help](#contributing-and-help) +- [License](#license) + +--- + +## Installation + +Kindly run the command below to install this package: + +```sh +npm install apitoolkit-js +``` + +## Configuration + +Next, initialize APItoolkit in your application's entry point (e.g., `index.js`), like so: + +```js +import { APIToolkit, ReportError, observeAxios } from "apitoolkit-js"; + +const apiToolkitClient = APIToolkit.NewClient({ + apiKey: "{ENTER_YOUR_API_KEY_HERE}", + debug: false, + tags: ["environment: production", "region: us-east-1"], + serviceVersion: "v2.0", +}); + +... +``` + +> [!NOTE] +> +> - The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_source=github-sdks) generated from the APItoolkit dashboard. +> - To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read any of the [NodeJS SDK documentation](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks). + +## Contributing and Help + +To contribute to the development of this PROJECT or request help from the community and our team, kindly do any of the following: +- Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md). +- Join our community [Discord Server](https://discord.gg/dEB6EjQnKB). +- Create a [new issue](https://github.com/apitoolkit/apitoolkit-js/issues/new/choose) in this repository. + +## License + +This repository is published under the [MIT](LICENSE) license. + +--- + +
+ + + +
+ From 5568223910e5c9f392ecb921066aa440dd1d6d9e Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji Date: Thu, 4 Jul 2024 21:36:16 +0100 Subject: [PATCH 2/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9086918..0effc8a 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,12 @@ ![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only) ![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only) -## JS SDKs Shared Code +## Javascript SDKs Shared Code [![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=javascript)](https://github.com/topics/apitoolkit-sdk) [![](https://img.shields.io/npm/v/apitoolkit-js.svg?logo=npm)](https://npmjs.com/package/apitoolkit-js) [![](https://img.shields.io/npm/dw/apitoolkit-js )](https://npmjs.com/package/apitoolkit-js) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://discord.gg/dEB6EjQnKB) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) -APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) based on the framework your application is built with or directly use this `apitoolkit-js` package (the shared code for all the JS SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers. +APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS framework SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) or directly use this `apitoolkit-js` package (the shared code for all the JS SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers. From 17b32cec7c01caf4fb4019a939f268e095b04cb4 Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji Date: Thu, 4 Jul 2024 21:38:23 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0effc8a..8be3967 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=javascript)](https://github.com/topics/apitoolkit-sdk) [![](https://img.shields.io/npm/v/apitoolkit-js.svg?logo=npm)](https://npmjs.com/package/apitoolkit-js) [![](https://img.shields.io/npm/dw/apitoolkit-js )](https://npmjs.com/package/apitoolkit-js) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://discord.gg/dEB6EjQnKB) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) -APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS framework SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) or directly use this `apitoolkit-js` package (the shared code for all the JS SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers. +APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS framework SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) or directly use this `apitoolkit-js` package (the shared code for all the Javascript SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers. From 2d6ad56c47a7444038b1055024d28da38415f98b Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji Date: Wed, 10 Jul 2024 10:58:31 +0100 Subject: [PATCH 4/5] docs: update UTM on links --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8be3967..7d46670 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## Javascript SDKs Shared Code [![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=javascript)](https://github.com/topics/apitoolkit-sdk) [![](https://img.shields.io/npm/v/apitoolkit-js.svg?logo=npm)](https://npmjs.com/package/apitoolkit-js) [![](https://img.shields.io/npm/dw/apitoolkit-js -)](https://npmjs.com/package/apitoolkit-js) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://discord.gg/dEB6EjQnKB) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) +)](https://npmjs.com/package/apitoolkit-js) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS framework SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) or directly use this `apitoolkit-js` package (the shared code for all the Javascript SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers. @@ -50,14 +50,14 @@ const apiToolkitClient = APIToolkit.NewClient({ > [!NOTE] > -> - The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_source=github-sdks) generated from the APItoolkit dashboard. -> - To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read any of the [NodeJS SDK documentation](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks). +> - The `{ENTER_YOUR_API_KEY_HERE}` demo string should be replaced with the [API key](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard. +> - To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read any of the [NodeJS SDK documentation](https://apitoolkit.io/docs/sdks/nodejs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme). ## Contributing and Help To contribute to the development of this PROJECT or request help from the community and our team, kindly do any of the following: - Read our [Contributors Guide](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md). -- Join our community [Discord Server](https://discord.gg/dEB6EjQnKB). +- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme). - Create a [new issue](https://github.com/apitoolkit/apitoolkit-js/issues/new/choose) in this repository. ## License @@ -68,7 +68,7 @@ This repository is published under the [MIT](LICENSE) license.
- +
From 0e272a1321f35ecb3b694190353182ba8c4c5209 Mon Sep 17 00:00:00 2001 From: Bolaji Ayodeji Date: Wed, 10 Jul 2024 11:04:49 +0100 Subject: [PATCH 5/5] docs: update UTM on links --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d46670..520317d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=javascript)](https://github.com/topics/apitoolkit-sdk) [![](https://img.shields.io/npm/v/apitoolkit-js.svg?logo=npm)](https://npmjs.com/package/apitoolkit-js) [![](https://img.shields.io/npm/dw/apitoolkit-js )](https://npmjs.com/package/apitoolkit-js) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/nodejs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) -APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS framework SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_source=github-sdks) or directly use this `apitoolkit-js` package (the shared code for all the Javascript SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers. +APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Javascript application with APItoolkit, you can use any of the [existing NodeJS framework SDKs](https://apitoolkit.io/docs/sdks/nodejs?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) or directly use this `apitoolkit-js` package (the shared code for all the Javascript SDKs) to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.