Removed hide splash screen preference. Updated docs.

ejolly · Oct 4, 2020 · e164f77 · e164f77
1 parent 0d6c5f5
commit e164f77
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 12 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -7,6 +7,9 @@ Because SvelteTurk is built on [web technologies](https://www.electronjs.org/),
 
 ![](assets/devtools.png)
 
+
+## MTurk API
+
 In it's current form SvelteTurk makes the entire [Mturk Javascript API](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/MTurk.html) available to you right from this console! This means you can *technically* interact with Mturk almost entirely through code without ever using SvelteTurk's user interface. This can be particularly handy by writing and save [code snippets](https://medium.com/@ishwar.rimal/running-javascript-snippets-with-chrome-dev-tool-94d541b22db3) in this developer console. You can create and save snippets by clicking on the following menu options in the console: Sources > >> Arrow > Snippets. From the left you can create a new snippet and save and run it by pressing `cmd+enter`. The picture below demos asking Mturk for your account balance using the API asynchronously. This is the same thing SvelteTurk is doing behind the scenes!
 
 ![](assets/devtoolsSnippet.png)

diff --git a/docs/overview.md b/docs/overview.md
@@ -1,6 +1,6 @@
 # Overview
 
-SvelteTurk's layout is organized with a sidebar on the left and a page view to the right. On successful startup, this view will always being on your home page.
+SvelteTurk's layout is organized with a sidebar on the left and a page view to the right. On successful startup, this view will always be the home page.
 
 ## Sidebar 
 

diff --git a/docs/settings.md b/docs/settings.md
@@ -2,14 +2,17 @@
 
 At any point in time you can change SvelteTurk settings by clicking on the Settings button in the side bar. As development on SvelteTurk continues, the number of configurable settings will grow. If you have recommendations or suggestions feel free to [open a github issue and apply a feature request label](https://github.com/ejolly/svelte-turk/issues/new). 
 
+## Updates
+
+SvelteTurk will automatically check for updates on startup. You can also force checking for an update by reloading the window.
+
 ## Current Configurable Settings
 
 | Setting Name          | Default Value | Description                                                                                                                                                                                                                                                                                                                        |
 | --------------------- | ------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | Refresh Frequency     | 30            | How often (*in seconds*) SvelteTurk will try to refresh HIT and Assignment data from Mturk servers. Setting this too low may produce errors as Amazon limits the total number of requests in a given period. Setting this too high will result infrequent updates. Something in the range 10-60 should provide reasonable updates. |
 | Allow Repeat Bonusing | False         | Whether SvelteTurk should allow Bonusing a Worker more than once.                                                                                                                                                                                                                                                                  |
 | Display Help Text     | True          | Whether SvelteTurk should display explanations under each input on the Create page                                                                                                                                                                                                                                                 |
-| Hide Splash Screen    | False         | Whether SvelteTurk should display its loading animation on startup. **Note:** A current bug may break the rendering other UI elements if this is turned on, so it's currently recommend to leave it at its default value.                                                                                                          |
 
 ## Svelte Data Storage
 

diff --git a/main/main.js b/main/main.js
@@ -78,7 +78,6 @@ let userSettings = {
   refreshFrequency: 30,
   repeatBonuses: false,
   createHITHelpers: true,
-  hideSplash: false,
 };
 if (fs.existsSync(settingsFile)) {
   fs.readFile(settingsFile, (err, data) => {

diff --git a/renderer/src/App.svelte b/renderer/src/App.svelte
@@ -124,9 +124,7 @@
       userSettings.set(resp.userSettings);
       initMTurk();
       bindAPI();
-      if (!$userSettings.hideSplash) {
-        await wait(3000);
-      }
+      await wait(3000);
       ready = true;
       stLog.info('app ready');
     }
@@ -200,7 +198,7 @@
 <Tailwindcss />
 <Modal bind:showModal bind:modalType bind:modalText />
 <!-- Main app container full window size not responsive-->
-{#if !ready && !$userSettings.hideSplash}
+{#if !ready}
 <Splash {updating} {updateComplete} />
 {:else}
 <div class="w-screen h-screen">

diff --git a/renderer/src/components/Sidebar.svelte b/renderer/src/components/Sidebar.svelte
@@ -107,11 +107,6 @@
             <input type="checkbox" class="mx-4" bind:checked={$userSettings.createHITHelpers} />
           </label>
         </div>
-        <div class="inline-flex px-3 space-x-4">
-          <label>Hide splash screen on startup
-            <input type="checkbox" class="mx-4" bind:checked={$userSettings.hideSplash} />
-          </label>
-        </div>
         <hr class="block w-full mt-2 mb-4 border-gray-500" />
         <button class="button" type="submit">Save</button>
       </div>