Skip to content

Commit

Permalink
Prep 0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
georgeboot committed Jan 28, 2021
1 parent 88117b8 commit 24804b2
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
# laravel-echo-api-gateway

## !! Work in progress !!

Note that this package is a work in progress. As soon as version 0.1 will be tagged, it will be usable for testing
purposes. As soon as version 1.0 gets released, it should be usable for production purposes.

## About

This package enables you to use API Gateway‘s Websockets as a driver for [Laravel Echo](https://github.com/laravel/echo)
Expand All @@ -17,6 +12,9 @@ messages. We also configure Laravel to use this connection as a broadcast driver
This package currently only works with either [Bref](https://bref.sh) or [Laravel Vapor](https://vapor.laravel.com),
though the latter one involves some manual set-up.

As soon as version 1.0 will be released, this package will be suitable for production workloads. Until then, it is
advised to only use this package for non-critical / non-production projects.

## Requirements

In order to use this package, your project needs to meet the following criteria:
Expand Down

0 comments on commit 24804b2

Please sign in to comment.