Skip to content
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.

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

README.md: Add short release note about Styx 1.0 API. #248

Merged
merged 6 commits into from
Aug 30, 2018
Merged
Changes from 3 commits
Commits
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ Styx is a programmable reverse proxy for JVM (Java Virtual Machine). It can be u
as a stand-alone application, or as a platform to build custom networking applications.
It is non-blocking, fully asynchronous and event driven therefore very scalable.

### Upcoming Release Note

[Styx 1.0](https://github.com/HotelsDotCom/styx/wiki/Styx-1.0-API) is coming to
public release soon. `master` is now following bleeding edge for Styx 1.0.
Styx 0.7 code is available in `styx-0.7` branch which is in maintenance
mode for bug fixes only. Follow the [Styx Wiki](https://github.com/HotelsDotCom/styx/wiki)
for latest developments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps the phrasing would work better as:

Styx 1.0 will be publicly released soon.
The master is now the bleeding edge for Styx 1.0.
Styx 0.7 code is available in the styx-0.7 branch which is in maintenance mode (bug fixes only).
Follow the Styx Wiki for latest developments.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ack


### Features

Styx Proxies HTTP requests to a configurable set of *Backend Services* typically a cluster
of web servers (multiple origins) or load balancers (e.g. AWS ELB).

Expand Down