docs: 📝 Add documentation about the preset format

Author: ChildishGiant

README.md

@@ -24,9 +24,42 @@ The brains behind Cloverleaf
 ## siteData
 **Returns**: <code>object</code> - Data for preset sites
 
+Schema (How the JSON is structured):
+
+```json
+"App Name": {
+  "alias": "Real app", // Makes passwords as if this was the app name
+  "minLength": 4, // The minimum length of a password allowed on this preset (inclusive)
+  "maxLength": 512, // The maximum length of a password allowed on this preset (inclusive)
+  "chars": "abc123", // The password will be made out of a random selection of these characters.
+  "deprecated": false, // Used to hide presets
+  "regex": "^(?!.*(.)\\1{2,}).+", // A regex the password must match. This one disallows repetitions of 3 or more of the same character
+  "requirements": ["cap", "low", "num", "special"], // Passwords must have at least one of these character types
+}
+```
+
+The only requirements for a valid preset is an alias or minimum length, the rest is optional.
+
 
 # Contributing
 
-`
-pnpm i
-`
+## Creating a new preset
+Making a new preset is pretty easy. All data for presets is kept in [sites.json](/data/sites.json). There's a json schema that describes what is needed but the tl;dr is this:
+
+Add a new key in the JSON object (in alphabetical order) with the name of the site/app you're making a preset for.
+
+### Working out a site's restrictions
+#### Character restrictions
+A good first test is pasting this in and seeing if it's upset about any characters:
+
+``0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~``
+
+If it is then you need to work out which it doesn't like. This can take a long time but can be sped up if you use a kind of binary search and half the string until you can pinpoint what is causing an issue.
+
+#### Length restrictions
+You also then need to work out if there are any minimum and maximum lengths. The first is easily discovered by attempting to use just "a" or something like that. For the maximum length I generally try a string that's over 512 characters (the default max for cloverleaf passwords).
+
+#### Other restrictions
+Some sites have basic restrictions such as "must have a special character" or "must use a number and a capital". For these we use the "requirements" key and an array or required character types ("cap", "low", "num" and "special")
+
+Some websites disallow repeated characters (EG. `aaa`) or common phrases like `qwerty`, `abc` or `123`. If a site has these restrictions you will need to add a regex.

data/sites_schema.json

@@ -1,49 +1,52 @@
 {
-	"$schema": "http://json-schema.org/draft-07/schema#",
-	"type": "object",
-	"patternProperties": {
-		"^[^\"\/\\\n]+$": {
-			"properties": {
-				"alias": {
-					"type": "string"
-				},
-				"chars": {
-					"type": "string",
-					"pattern": "^(?!.*(.).*\\1).+$"
-				},
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "patternProperties": {
+    "^[^\"\/\\\n]+$": {
+      "properties": {
+        "alias": {
+          "type": "string",
+          "description": "Used to redirect internally (YouTube passwords should be the same as Google passwords)"
+        },
+        "chars": {
+          "type": "string",
+          "pattern": "^(?!.*(.).*\\1).+$"
+        },
         "deprecated": {
           "type": "boolean"
         },
-				"maxLength": {
-					"minimum": 1,
-					"type": "integer"
-				},
-				"minLength": {
-					"minimum": 1,
-					"type": "integer",
-					"description": "The minimum length of a password allowed on this preset (inclusive)"
-				},
-				"regex": {
-					"type": "string",
-					"format": "regex"
-				},
-				"requirements": {
-					"type": "array",
-					"minItems": 1,
-					"maxItems": 4,
-					"uniqueItems": true,
-					"items": {
-						"type": "string",
-						"enum": ["cap",	"low", "num",	"special"]
-					}
-				}
-			},
-			"anyOf": [
-				{ "required": ["alias"]},
-				{ "required": ["minLength"]}
+        "maxLength": {
+          "minimum": 1,
+          "type": "integer",
+          "description": "The maximum length of a password allowed on this preset (inclusive)"
+        },
+        "minLength": {
+          "minimum": 1,
+          "type": "integer",
+          "description": "The minimum length of a password allowed on this preset (inclusive)"
+        },
+        "regex": {
+          "type": "string",
+          "format": "regex",
+          "description": "A regex that the password will be tested against. If it returns true, the password can be used."
+        },
+        "requirements": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 4,
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "enum": ["cap", "low", "num", "special"]
+          }
+        }
+      },
+      "anyOf": [
+        { "required": ["alias"]},
+        { "required": ["minLength"]}
       ],
-			"type": "object",
-			"additionalProperties": false
-		}
-	}
+      "type": "object",
+      "additionalProperties": false
+    }
+  }
 }

index.js

@@ -107,6 +107,7 @@ export function generate (appName, masterPass, presetToggle = false, length = de
 
   }
 
+  // Correct the desired password length to fit a preset
   if (!(minLength <= length && length <= maxLength)) {
     // if the length is invalid
     if (length > maxLength) {