feat: more docs

README.md

@@ -102,9 +102,13 @@ const settingsManager = new SettingsManager<Schema>(
   }
 )
 
-// any key other than 'theme' and 'startFullscreen' will be invalid.
-// theme key will only accept 'dark' or 'light' as a value due to the generic.
-settingsManager.setCache('theme', 'dark');
+// checks whether the settings file exists and created it if not
+// loads the settings if it exists
+settingsManager.initialize().then(() => {
+  // any key other than 'theme' and 'startFullscreen' will be invalid.
+  // theme key will only accept 'dark' or 'light' as a value due to the generic.
+  settingsManager.setCache('theme', 'dark');
+}
 
 // at a later time
 await settingsManager.syncCache();

src/settings-manager/settings-manager.ts

@@ -20,7 +20,7 @@ export class SettingsManager<SettingsSchema extends {} = any> {
    * Initializes a settings file with the defaults. If settings exist, load them.
    * @returns The entire settings object
    */
-  async initialize() {
+  async initialize(): Promise<SettingsSchema> {
     const currentSettings = await getSettings<SettingsSchema>();
     this.path = currentSettings.path;