diff --git a/README.md b/README.md index f6557d9..bd058c0 100644 --- a/README.md +++ b/README.md @@ -9,25 +9,34 @@ [Java Quickstart guide](https://developer.squareup.com/docs/sdks/java/quick-start) - The quickstart directory is based off of this document. +[Maven Repository for Square](https://mvnrepository.com/artifact/com.squareup/square) - Where the package files are hosted + +[Java SDK Source Code](https://github.com/square/square-java-sdk) - Github repo with sdk source code ## Quickstart instructions -Change into the `quickstart` directory +1. Change into the `quickstart` directory + +1. Copy the example config file in `src/main/resources`, and place your `Square Access Token` inside of the new file. -Copy the example config file in `src/main/resources`, and place your `Square Access Token` inside of the new file. + ``` + $ cp src/main/resources/config.properties.example src/main/resources/config.properties + ``` -``` -$ cp src/main/resources/config.properties.example src/main/resources/config.properties -``` +1. Replace `PLACE_VERSION_HERE` with the latest SDK version from [here](https://developer.squareup.com/docs/sdks/java) -Compile the program -``` -$ mvn package -DskipTests -``` +1. Compile the program + ``` + $ mvn package -DskipTests + ``` -Execute the code -``` -$ mvn exec:java -Dexec.mainClass="com.square.examples.Quickstart" -``` +1. Execute the code + ``` + $ mvn exec:java -Dexec.mainClass="com.square.examples.Quickstart" + ``` -You should see your `Square Sandbox Seller account's` location logged in the console. \ No newline at end of file +1. In your console, you should see output similar to this: + ``` + Location(s) for this account: + LGJ1WWJ8PSV8Z: Default Test Account, 1600 Pennsylvania Ave NW, Washington + ``` \ No newline at end of file diff --git a/quickstart/pom.xml b/quickstart/pom.xml index 3a54884..95ec7e9 100644 --- a/quickstart/pom.xml +++ b/quickstart/pom.xml @@ -10,7 +10,7 @@ com.squareup square - 38.1.0.20240320 + PLACE_VERSION_HERE compile