Skip to content
This repository has been archived by the owner on Dec 9, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdebrie authored Apr 8, 2018
1 parent e326d1a commit 267b1fb
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ dataflow for event-driven, serverless architectures. It routes Events (data) to
Everything it cares about is an event! Even calling a function. It makes it easy to share events across different
systems, teams and organizations!

Use the Event Gateway right now, by running the **[Event Gateway Example Application](https://github.com/serverless/event-gateway-example)** locally, with the _[Serverless Framework](https://serverless.com/framework/)_.
Use the Event Gateway right now, by running the **[Event Gateway Getting Started Application](https://github.com/serverless/event-gateway-getting-started)** with the _[Serverless Framework](https://serverless.com/framework/)_.

Features:

Expand All @@ -28,6 +28,7 @@ yet ready for production applications._
## Contents

1. [Quick Start](#quick-start)
1. [Running the Event Gateway](#running-the-event-gateway)
1. [Motivation](#motivation)
1. [Components](#components)
1. [Function Discovery](#function-discovery)
Expand All @@ -46,17 +47,14 @@ yet ready for production applications._

## Quick Start

### Example projects
### Getting Started

Looking for some examples to get started? The easiest way to use the Event Gateway is with the [`serverless-event-gateway-plugin`](https://github.com/serverless/serverless-event-gateway-plugin) with the Serverless Framework. Below are a few walkthrough examples:

- To use custom events to allow for asynchronous, decoupled communication between services, check out [this example](./examples/crm-service) on updating your CRM service whenever a new user is created in your Users service.
- For using Event Gateway as an API Gateway to tie together hundreds of functions across multiple services, look at [this example](./examples/users-service) for deploying a REST-like Users service with standard CRUD endpoints.

To use these examples, you'll need a running instance of the Event Gateway. Check out the different methods below.
Looking for an example to get started? The easiest way to use the Event Gateway is with the [`serverless-event-gateway-plugin`](https://github.com/serverless/serverless-event-gateway-plugin) with the Serverless Framework. Check out the [**Getting Started Example**](https://github.com/serverless/event-gateway-getting-started) to deploy your first service to the Event Gateway.

---

## Running the Event Gateway

### Hosted version

If you don't want to run the Event Gateway yourself, you can use the hosted version provided by the Serverless team. Please [contact us](mailto:hello@serverless.com) for an invitation to the beta.
Expand Down

0 comments on commit 267b1fb

Please sign in to comment.