Update README.md

README.md

@@ -6,7 +6,7 @@
 
 
 -
-# Part 1.1 - Create class `Option`
+## Part 1.1 - Create class `Option`
 * Create an `Option` class in the `domain` sub-package.
 * `Option` class signature is annotated with `@Entity`
 * `Option` has an `id` instance variable of type `Long`
@@ -26,7 +26,7 @@
 
 
 -
-# Part 1.2 - Create class `Poll`
+## Part 1.2 - Create class `Poll`
 * Create a `Poll` class in the `domain` sub-package.
 * `Poll` class signature is annotated with `@Entity`
 * `Poll` has an `id` instance variable of type `Long`
@@ -50,7 +50,7 @@
 
 
 -
-# Part 1.3 - Create class `Vote`
+## Part 1.3 - Create class `Vote`
 * Create a `Vote` class in the `domain` sub-package.
 * `Vote` class signature is annotated with `@Entity`
 * `Vote` has an `id` instance variable of type `Long`
@@ -79,17 +79,17 @@
 
 
 -
-# Part 2.1 - Create interface `OptionRepository`
+## Part 2.1 - Create interface `OptionRepository`
 * Create an `OptionRepository` interface in the `repositories` subpackage.
 * `OptionRepository` extends `CrudRepository<Option, Long>`
 
 -
-# Part 2.2 - Create interface `PollRepository`
+## Part 2.2 - Create interface `PollRepository`
 * Create a `PollRepository` interface in the `repositories` subpackage.
 * `PollRepository` extends `CrudRepository<Poll, Long>`
 
 -
-# Part 2.3 - Create interface `VoteRepository`
+## Part 2.3 - Create interface `VoteRepository`
 * Create a `VoteRepository` interface in the `repositories` subpackage.
 * `VoteRepository` extends `CrudRepository<Vote, Long>`
 
@@ -107,7 +107,7 @@
 
 
 -
-# Part 3.1 - Create class `PollController`
+## Part 3.1 - Create class `PollController`
 * Create a `PollController` class in the `controller` sub package.
 	* `PollController` signature should be `annotated` with `@RestController`
 
@@ -115,7 +115,7 @@
 	* `pollRepository` should be `annotated` with `@Inject`
 
 -
-# Part 3.1.1 - Create `GET` request method
+### Part 3.1.1 - Create `GET` request method
 * The method definition below supplies a `GET` request on the `/polls` endpoint which provides a collection of all of the polls available in the QuickPolls application. Copy and paste this into your `PollController` class.
 
 ```java
@@ -134,7 +134,7 @@ public ResponseEntity<Iterable<Poll>> getAllPolls() {
 
 
 -
-# Part 3.1.2 - Testing via Postman
+### Part 3.1.2 - Testing via Postman
 * Ensure that the `start-class` tag in your `pom.xml` encapsulates `io.zipcoder.springdemo.QuickPollApplication`
 * Open a command line and navigate to the project's root directory and run this command:
 	* `mvn spring-boot:run`
@@ -145,7 +145,7 @@ public ResponseEntity<Iterable<Poll>> getAllPolls() {
 
 
 -
-# Part 3.1.3 - Create `POST` request method
+### Part 3.1.3 - Create `POST` request method
 * We accomplish the capability to add new polls to the `PollController` by implementing the `POST` verb functionality in a `createPoll` method:
 
 ```java
@@ -166,7 +166,7 @@ public ResponseEntity<?> createPoll(@RequestBody Poll poll) {
 
 
 -
-# Part 3.1.4 - Modify `createPoll`
+### Part 3.1.4 - Modify `createPoll`
 * Best practice is to convey the URI to the newly created resource using the Location HTTP header via Spring's `ServletUriComponentsBuilder` utility class. This will ensure that the client has some way of knowing the URI of the newly created Poll.
 
 ```java
@@ -183,7 +183,7 @@ URI newPollUri = ServletUriComponentsBuilder
 
 
 -
-# Part 3.1.5 - Create `GET` request method
+### Part 3.1.5 - Create `GET` request method
 * The code snippet below enables us to access an individual poll.
 * The _value attribute_ in the `@RequestMapping` takes a URI template `/polls/{pollId}`.
 * The placeholder `{pollId}` along with `@PathVarible` annotation allows Spring to examine the request URI path and extract the `pollId` parameter value.
@@ -201,7 +201,7 @@ public ResponseEntity<?> getPoll(@PathVariable Long pollId) {
 
 
 -
-# Part 3.1.6 - Create `UPDATE` request method
+### Part 3.1.6 - Create `UPDATE` request method
 * The code snippet below enables us to update a poll.
 
 ```java
@@ -216,7 +216,7 @@ public ResponseEntity<?> updatePoll(@RequestBody Poll poll, @PathVariable Long p
 
 
 -
-# Part 3.1.7 - Create `DELETE` request method.
+### Part 3.1.7 - Create `DELETE` request method.
 
 * The code snippet below enables us to delete a poll.
 
@@ -232,7 +232,7 @@ public ResponseEntity<?> deletePoll(@PathVariable Long pollId) {
 
 
 -
-# Part 3.1.8 - Test
+### Part 3.1.8 - Test
 * Restart the QuickPoll application.
 * Use Postman to execute a `PUT` to `http://localhost:8080/polls/1` whose request body is the `JSON` object below.
 * You can modify the request body in Postman by navigating to the `Body` tab, selecting the `raw` radio button, and selecting the `JSON` option from the text format dropdown.
@@ -252,7 +252,7 @@ public ResponseEntity<?> deletePoll(@PathVariable Long pollId) {
 
 
 -
-# Part 3.2 - Create class `VoteController`
+## Part 3.2 - Create class `VoteController`
 * Following the principles used to create `PollController`, we implement the `VoteController` class.
 * Below is the code for the `VoteController` class along with the functionality to create a vote.
 * The `VoteController` uses an injected instance of `VoteRepository` to perform `CRUD` operations on Vote instances.
@@ -276,7 +276,7 @@ public class VoteController {
 }
 ```
 
-# Part 3.2.1 - Testing `VoteController`
+### Part 3.2.1 - Testing `VoteController`
 * To test the voting capabilities, `POST` a new Vote to the `/polls/1/votes` endpoint with the option object expressed in `JSON` below.
 * On successful request execution, you will see a Location response header with value http://localhost:8080/polls/1/votes/1.
 
@@ -290,7 +290,7 @@ public class VoteController {
 
 
 -
-# Part 3.2.2 - Modify `VoteRepository`
+### Part 3.2.2 - Modify `VoteRepository`
 * The method `findAll` in the `VoteRepository` retrieves all votes in a Database rather than a given poll.
 * To ensure we can get votes for a given poll, we must add the code below to our `VoteRepository`.
 
@@ -311,7 +311,7 @@ public interface VoteRepository extends CrudRepository<Vote, Long> {
 
 
 -
-# Part 3.2.3 - Modify `VoteController`
+### Part 3.2.3 - Modify `VoteController`
 * Create a `getAllVotes` method in the `VoteController`