Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gkobilansky authored Jun 12, 2018
1 parent 27746ee commit d6c4eb5
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ A simple message queue using node, Redis and the Serverless framework

## Features

This is a sample setup of a messaging service (instead of using Amazon SMS for example).

* Initialize new queue in your Redis server
* List available queues
* Send and receive messages
Expand All @@ -11,9 +13,6 @@ A simple message queue using node, Redis and the Serverless framework

**Please note:** although you can initialize multiple queues, current implementation for send/receive/delete works with hardcoded queue name of `myqueue`.

## Demo

You can send messages to WonderQ and see the demo queue stats at our [front end](http://quick-start-dev-serverlessdeploymentbucket-ntikgcvze067.s3-website-us-east-1.amazonaws.com/index.html).

## Setup

Expand All @@ -39,7 +38,6 @@ You can send messages to WonderQ and see the demo queue stats at our [front end]

**POST /init**

demo: https://rnyin3rr0e.execute-api.us-east-1.amazonaws.com/dev/init

_Parameters:_

Expand All @@ -57,7 +55,6 @@ Creates a new queue, returns confirmation. `vt` sets how long a message is invis

**GET /queues**

demo: https://rnyin3rr0e.execute-api.us-east-1.amazonaws.com/dev/queues

_Parameters:_ none

Expand All @@ -67,7 +64,6 @@ Returns a list of all queues.

**POST /messages/send**

demo: https://rnyin3rr0e.execute-api.us-east-1.amazonaws.com/dev/messages/send

_Parameters:_ body - required

Expand All @@ -80,15 +76,13 @@ Adds message to queue, returns message ID.

**GET /messages/receive**

demo: https://rnyin3rr0e.execute-api.us-east-1.amazonaws.com/dev/messages/receive

_Parameters:_ none

Returns top (visible) message from the queue. Makes message invisible for 30 seconds.

**POST /messages/delete**

demo: https://rnyin3rr0e.execute-api.us-east-1.amazonaws.com/dev/messages/delete

_Parameters:_ body = messageID - required

Expand All @@ -99,8 +93,6 @@ Ex:

**GET /info**

demo: https://rnyin3rr0e.execute-api.us-east-1.amazonaws.com/dev/info

_Parameters:_ none

Returns developer info about the message queue.

0 comments on commit d6c4eb5

Please sign in to comment.