Skip to content

Commit 51165ec

Browse files
committed
readme
1 parent 9d2ab2a commit 51165ec

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,15 @@ Other branches extend the application's functionality and show the use of other
1212
- [`xray`](https://github.com/awslabs/eb-java-scorekeep/tree/xray) - Use the AWS X-Ray SDK to instrument incoming requests, SDK clients, SQL queries, HTTP clients, and sections of code.
1313
- [`xray-gettingstarted`](https://github.com/awslabs/eb-java-scorekeep/tree/xray-gettingstarted) ([tutorial](https://docs.aws.amazon.com/xray/latest/devguide/xray-gettingstarted.html)) - Use the AWS X-Ray to instrument incoming requests and SDK clients (no additional configuration required).
1414

15-
Use the procedures in the following sections to run the project on AWS Elastic Beanstalk and configure it for local testing and development.
15+
Use the procedures in the following sections to run the project on AWS Elastic Beanstalk and configure it for local testing and development.
16+
17+
**Sections**
18+
- [Prerequisites](#prerequisites)
19+
- [Deploy the application](#deploy-the-application)
20+
- [Configure notifications](#configure-notifications)
21+
- [How it works](#how-it-works)
22+
- [Running the project locally](#running-the-project-locally)
23+
- [Contributing](#contributing)
1624

1725
# Prerequisites
1826
- User permissions - Elastic Beanstalk, IAM*
@@ -68,7 +76,7 @@ Deploy the source code for the project to your Elastic Beanstalk environment.
6876

6977
Click through the app to explore its functionality. Use the network console in your browser to see the HTTP requests that it sends to the API to read and write users, sessions, games, moves and game state to DynamoDB via the API.
7078

71-
# Configure Notifications
79+
# Configure notifications
7280
The API uses Amazon SNS to send a notification email when a game ends. To enable notifications, configure your email address in an environment variable.
7381

7482
*To enable notifications*

0 commit comments

Comments
 (0)