Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
johnwatson484 committed Dec 19, 2020
1 parent 4cf9844 commit b69b6c6
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Build Status](https://johnwatson484.visualstudio.com/John%20D%20Watson/_apis/build/status/johnwatson484.azure-service-bus-test-client?branchName=master)](https://johnwatson484.visualstudio.com/John%20D%20Watson/_build/latest?definitionId=24&branchName=master)

# Azure Service Bus Test Client
A test client for sending JSON format messages to Azure Service Bus
A test client for sending and receiving JSON format messages with Azure Service Bus

## Prerequisites
Node v12+
Expand Down Expand Up @@ -37,16 +37,22 @@ This must be in the below format and note that the validation provided by the cl
`Endpoint=sb://YOUR_HOSTNAME/;SharedAccessKeyName=KEYNAME;SharedAccessKey=KEY`

### Set the queue or topic name
This is the queue or topic where the message will be sent to.
This is the queue or topic where the message will be sent to or received from.

## Sending a message
### Message
This is the message that will be sent to the specified resource and must be in JSON format.

### Set the message format
Messages can be sent as JSON or stringified JSON.

### Message
This is the message that will be sent to the specified resource and must be in JSON format.
### Set the number of copies of the message to send

## Receiving a message
### Subscription
If messages are to be received from a topic, then set the subscription name.

### Entity
Messages can be sent to either a queue or topic.
### Set the number of messages to receive

## Errors
If invalid crendentials or malformed JSON is provided an error will be returned through the client.
Binary file modified docs/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "azure-service-bus-test-client",
"version": "1.4.0",
"description": "A client to send and receive messages from Azure Service Bus",
"version": "1.4.1",
"description": "A client to send and receive messages with Azure Service Bus",
"main": "./app/index.js",
"scripts": {
"start": "node app",
Expand Down

0 comments on commit b69b6c6

Please sign in to comment.