Skip to content

Update README.md #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 19, 2025
Merged

Update README.md #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# [WIP] RabbitMQ AMQP 1.0 JavaScript Client
# RabbitMQ AMQP 1.0 JavaScript Client

# NOT READY FOR PRODUCTION - The client is HEAVILY work in progress.
This library is meant to be used with RabbitMQ 4.0. </br>
Suitable for testing in pre-production environments. The public API(s) could change.

[![Build Status](https://github.com/coders51/rabbitmq-amqp-js-client/actions/workflows/main.yml/badge.svg)](https://github.com/coders51/rabbitmq-amqp-js-client/actions)

This library is meant to be used with RabbitMQ 4.0.

# Table of Contents

- [Installing via NPM](#installing-via-npm)
Expand All @@ -26,7 +25,9 @@ The client is distributed via **npm**:

## Getting started

**NOTE:** this is just a first example and will be replaced with the reference to the _examples folder_
**NOTE:** This is just a first example and will be replaced with a reference to the _examples folder_

The following example demonstrates how to create an environment, open a connection, and use the management to create and delete queues, exchanges, and bindings.

```typescript
const environment = createEnvironment({
Expand Down Expand Up @@ -60,8 +61,6 @@ await connection.close()
await environment.close()
```

In this example we demonstrate how to create an environment, open a connection and use the management to create
or delete queues, exchanges and bindings.

## Resources

Expand Down