WIP

Author: Maximilian Schmidt

.gitignore

@@ -1 +1,2 @@
 /vendor/
+/Docs/Api/

.vscode/project.code-snippets

@@ -0,0 +1,43 @@
+{
+	// Place your crawler workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and 
+	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope 
+	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is 
+	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are: 
+	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. 
+	// Placeholders with the same ids are connected.
+	// Example:
+	// "Print to console": {
+	// 	"scope": "javascript,typescript",
+	// 	"prefix": "log",
+	// 	"body": [
+	// 		"console.log('$1');",
+	// 		"$2"
+	// 	],
+	// 	"description": "Log output to console"
+	// }
+	"PHP File": {
+		"scope": "php",
+		"prefix": "file",
+		"description": "A PHP file",
+		"body": [
+			"",
+			"/**",
+			" * ${1:File description}",
+			" *",
+			" * @package    mcstreetguy/crawler",
+			" * @author     Maximilian Schmidt <maximilianschmidt404@gmail.com>",
+			" * @copyright  2019, Maximilian Schmidt",
+			" * @license    https://github.com/MCStreetguy/Crawler/blob/master/LICENSE MIT",
+			" * @version    SVN: \\$Id\\$",
+			" */",
+			"",
+			"namespace MCStreetguy\\Crawler${2:\\\\};",
+			"",
+			"/*",
+			" * This file is part of the mcstreetguy/crawler package.",
+			" */",
+			"",
+			"$0"
+		]
+	}
+}

Classes/Crawler.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file contains the main crawler class.
+ *
+ * @package    mcstreetguy/crawler
+ * @author     Maximilian Schmidt <maximilianschmidt404@gmail.com>
+ * @copyright  2019, Maximilian Schmidt
+ * @license    https://github.com/MCStreetguy/Crawler/blob/master/LICENSE MIT
+ * @version    SVN: $Id$
+ */
+
+namespace MCStreetguy\Crawler;
+
+/*
+ * This file is part of the mcstreetguy/crawler package.
+ */
+
+/**
+ * The main class of the web-crawler.
+ * This is the entry point to every usage of this library.
+ */
+class Crawler
+{
+}

Docs/.gitkeep

@@ -0,0 +1 @@
+.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Maximilian Schmidt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,13 @@
+default:
+	echo "Please specify a task!" && exit
+
+update:
+	composer update -o
+
+build-docs: ensure-dependencies
+	./vendor/bin/phpdoc -c "./phpdoc.xml"
+
+ensure-dependencies: composer.lock
+	
+composer.lock:
+	composer install -o

composer.json

@@ -10,7 +10,8 @@
         "guzzlehttp/guzzle": "~6.0"
     },
     "require-dev": {
-        "kint-php/kint": "^3.2"
+        "kint-php/kint": "^3.2",
+        "phpdocumentor/phpdocumentor": "^2.9"
     },
     "suggest": {
         "ext-curl": "For improved network requests, replaces stream handler usage."