diff --git a/README.md b/README.md index 6484277..5cdf314 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ IBAN-Validator-Test =============== + +## Required software ## + - Maven 3 + - Java 8 + - curl or a web browser + +## How to use ## +Go to the root directory of the project with the terminal + + mvn jetty:run + +Open a new terminal + + curl -XGET --header "iban: [your iban]" http://localhost:8080/validator/validate -i + +Or open a browser to http://localhost:8080/validator/validate, just remember to set your header parameter iban.