diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a4ca9b --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# SPPK +### SimplyPlural -> PluralKit Connectivity. + +#### config.json +``` +"token": "token_here", +"userId": "userid_here", +"pk_token": "pluralkit_token_here", +"pk_system": "pluralkit_system_id" +``` +`token`: Your SimplyPlural account token. As of now, the only permission necessary is the Read permission. + +`userId`: Your SimplyPlural account/system ID. You can find it in account info near the bottom. + +`pk_token`: Your PluralKit token. Get it by using pk;token + +`pk_system`: Your Pluralkit system ID. This can be either your Discord account ID or your 5 letter ID shown by using pk;system.