Skip to content

Commit 6b69a26

Browse files
jremy42remyleone
andauthored
fix: add missing README.md for kafka package (#2565)
Co-authored-by: Rémy Léone <[email protected]>
1 parent 039c6a7 commit 6b69a26

File tree

1 file changed

+95
-0
lines changed

1 file changed

+95
-0
lines changed

packages_generated/kafka/README.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# @scaleway/sdk-kafka
2+
3+
[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-kafka.svg)](https://www.npmjs.com/package/@scaleway/sdk-kafka)
4+
[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-kafka.svg)](https://www.npmjs.com/package/@scaleway/sdk-kafka)
5+
[![license](https://img.shields.io/npm/l/@scaleway/sdk-kafka.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
6+
7+
Scaleway SDK for Kafka API.
8+
9+
> **Note**
10+
> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
11+
12+
## Installation
13+
14+
```bash
15+
npm install @scaleway/sdk-kafka @scaleway/sdk-client
16+
```
17+
18+
or with pnpm:
19+
20+
```bash
21+
pnpm add @scaleway/sdk-kafka @scaleway/sdk-client
22+
```
23+
24+
or with yarn:
25+
26+
```bash
27+
yarn add @scaleway/sdk-kafka @scaleway/sdk-client
28+
```
29+
30+
## Getting Started
31+
32+
You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
33+
34+
### Basic Usage
35+
36+
```typescript
37+
import { createClient } from '@scaleway/sdk-client'
38+
import { Kafka } from '@scaleway/sdk-kafka'
39+
40+
const client = createClient({
41+
accessKey: 'SCWXXXXXXXXXXXXXXXXX',
42+
secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
43+
defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
44+
defaultRegion: 'fr-par',
45+
defaultZone: 'fr-par-1',
46+
})
47+
48+
const api = new Kafka.v1.API(client)
49+
50+
// Use the API
51+
// Example: await api.listServers()
52+
```
53+
54+
### Using Configuration Loader
55+
56+
For a simpler setup, you can load credentials from the configuration file or environment variables:
57+
58+
```typescript
59+
import { createClient } from '@scaleway/sdk-client'
60+
import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
61+
import { Kafka } from '@scaleway/sdk-kafka'
62+
63+
const profile = loadProfileFromConfigurationFile()
64+
const client = createClient(profile)
65+
const api = new Kafka.v1.API(client)
66+
```
67+
68+
## Documentation
69+
70+
- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
71+
- 🌐 [Scaleway Kafka API Documentation](https://www.scaleway.com/en/developers/api/kafka/)
72+
- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
73+
- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
74+
75+
## Features
76+
77+
- ✅ Full TypeScript support with complete type definitions
78+
- ✅ Promise-based API
79+
- ✅ Automatic pagination helpers
80+
- ✅ Built-in error handling
81+
- ✅ Compatible with Node.js ≥ 20
82+
83+
## Support
84+
85+
We love feedback! Feel free to reach us on:
86+
- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
87+
- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
88+
89+
## Contributing
90+
91+
This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
92+
93+
## License
94+
95+
This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.

0 commit comments

Comments
 (0)