Added examples

Author: NikkelM

.gitignore

@@ -1,11 +1,11 @@
 # Custom
 
-output
+/output
 /dev
 **.xcf
 
 ## The user's custom configuration file
-config.json
+/config.json
 
 # Logs
 logs

README.md

@@ -6,7 +6,7 @@ This project provides a quick and easy way to get a list of all games currently
 
 Using the configuration file, the types and format of a large number of properties can be customized, from simply getting the game's names all the way to fetching store prices at the moment of the request.
 
-Take a look at the section below to see how to use the configuration file, or take the `config.default.json` file as an example and work from there.
+Take a look at the section below to learn how to use the configuration file, or take a look at the [examples](examples) and work from there.
 
 ## Setup
 
@@ -24,6 +24,8 @@ node index.js
 
 You will find the resulting data in the created `output` folder.
 
+Unsure how it works? Take a look at the [examples](examples) for some inspiration.
+
 ## Configuration
 
 ### Schema validation

examples/completionist/README.md

@@ -0,0 +1,5 @@
+# The "Completionist"
+
+This example configuration fetches as many properties as possible for a number of different markets.
+
+The values were fetched on 2021-03-01.

examples/completionist/config.json

@@ -0,0 +1,59 @@
+{
+	"$schema": "../../config.schema.json",
+	"markets": [
+		"US",
+		"RU"
+	],
+	"language": "en-us",
+	"platformsToFetch": [
+		"console",
+		"pc",
+		"eaPlay"
+	],
+	"outputFormat": "productId",
+	"treatEmptyStringsAsNull": true,
+	"keepCompleteProperties": false,
+	"includedProperties": {
+		"productTitle": true,
+		"productId": true,
+		"developerName": true,
+		"publisherName": true,
+		"categories": true,
+		"productDescription": {
+			"enabled": true,
+			"preferShort": false
+		},
+		"images": {
+			"enabled": true,
+			"imageTypes": {
+				"TitledHeroArt": -1,
+				"SuperHeroArt": -1,
+				"Logo": -1,
+				"Poster": -1,
+				"Screenshot": -1,
+				"BoxArt": -1,
+				"Hero": -1,
+				"BrandedKeyArt": -1,
+				"FeaturePromotionalSquareArt": -1
+			}
+		},
+		"releaseDate": {
+			"enabled": true,
+			"format": "dateTime"
+		},
+		"userRating": {
+			"enabled": true,
+			"aggregationInterval": "AllTime",
+			"format": "stars"
+		},
+		"pricing": {
+			"enabled": true,
+			"priceTypes": [
+				"ListPrice",
+				"MSRP",
+				"WholesalePrice"
+			],
+			"missingPricePolicy": "useNull"
+		}
+	}
+}

examples/completionist/output/formattedGameProperties_console_RU.json

@@ -0,0 +1,5 @@
+# The "Graphical Enthusiast"
+
+This example configuration fetches image URL's and user ratings for games that are available on Game Pass for PC.
+
+The values were fetched on 2021-03-01.

examples/completionist/output/formattedGameProperties_console_US.json

@@ -0,0 +1,32 @@
+{
+	"$schema": "../../config.schema.json",
+	"markets": [
+		"US"
+	],
+	"language": "en-us",
+	"platformsToFetch": [
+		"pc"
+	],
+	"outputFormat": "productTitle",
+	"includedProperties": {
+		"images": {
+			"enabled": true,
+			"imageTypes": {
+				"TitledHeroArt": -1,
+				"SuperHeroArt": -1,
+				"Logo": -1,
+				"Poster": -1,
+				"Screenshot": -1,
+				"BoxArt": -1,
+				"Hero": -1,
+				"BrandedKeyArt": -1,
+				"FeaturePromotionalSquareArt": -1
+			}
+		},
+		"userRating": {
+			"enabled": true,
+			"aggregationInterval": "AllTime",
+			"format": "stars"
+		}
+	}
+}

examples/completionist/output/formattedGameProperties_eaPlay_RU.json

@@ -0,0 +1,5 @@
+# The "Minimalist"
+
+This example configuration fetches only game names for games that are currently available on Game Pass for Console.
+
+The values were fetched on 2021-03-01.

examples/completionist/output/formattedGameProperties_eaPlay_US.json

@@ -0,0 +1,14 @@
+{
+	"$schema": "config.schema.json",
+	"markets": [
+		"US"
+	],
+	"language": "en-us",
+	"platformsToFetch": [
+		"console"
+	],
+	"outputFormat": "array",
+	"includedProperties": {
+		"productTitle": true
+	}
+}