Update ReadMe, fix typos

VictorGrycuk · Aug 18, 2020 · dbbc2f0 · dbbc2f0
1 parent 4f703b9
commit dbbc2f0
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,45 @@
-# StreamDeck-KeePass
-Simple interface to retrieve information from KeePass database.
+# KeePass for StreamDeck 
+## Description
 
-I wanted to learn how to use the [Elgato Stream Deck SDK](https://developer.elgato.com/documentation/stream-deck/sdk/overview/) using BarRaider's [Stream Deck Tools](https://github.com/BarRaider/streamdeck-tools), so I created this simple plug-in.
+Simple interface to retrieve information from a KeePass database and generate passwords using [KeePassLib](https://www.nuget.org/packages/KeePassLib/).
+
+I wanted to learn how to use the [Elgato Stream Deck SDK](https://developer.elgato.com/documentation/stream-deck/sdk/overview/) using BarRaider's [Stream Deck Tools](https://github.com/BarRaider/streamdeck-tools), so I created this simple plug-in.
+
+## Features
+
+#### Retrieve
+
+It retrieves a field of a stored entry from a `.kdbx` file and copies it to the clipboard.
+
+It uses the following configuration:
+
+- **KeePass db path.** The absolute path to the KeePass file.
+- **KeePass db password.** The main password of the KeePass file.
+- **Entry Name.** The name of the entry that has the desired information.
+- **Field to retrieve.** The field whose content will be copied to the clipboard
+  - Password
+  - Username
+  - Notes
+  - URL
+
+
+
+#### Generate
+
+it will generate a random password using [KeePassLib](https://www.nuget.org/packages/KeePassLib/) using the given configuration.
+
+It uses the following configuration:
+
+- **Password Length.** Default `20`.
+- **Lower Case.** `abcdefghijklmnopqrstuvwxyz`. Default `true`.
+- **Upper Case.** `ABCDEFGHIJKLMNOPQRSTUVWXYZ`. Default `true`.
+- **Use Digits.** `0123456789`. Default `true`.
+- **Use Punctuation.** `,.;:`. Default `true`.
+- **Use Brackets.** `()[]{}<>`. Default `true`.
+- **Use Special Characters.** ``!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~``. Default `true`.
+- **Exclude Look-Alike characters.** It will avoid using two character that look similar, like `O` and `0`. Default `false`.
+- **Must occur at most Once.** It will prevent characters from appearing more than once. Default `false`.
+
+Check [KeePass Password Generator](https://keepass.info/help/base/pwgenerator.html) help site for more information.
+
+The icon for this action is a modified version of *iOS Filled* at [Icon8](https://icons8.com).
diff --git a/StreamDeck-KeePass/StreamDeck-KeePass/KeePassGenerate.cs b/StreamDeck-KeePass/StreamDeck-KeePass/KeePassGenerate.cs
@@ -56,8 +56,8 @@ public static PluginSettings CreateDefaultSettings()
             [JsonProperty(PropertyName = "excludeLookAlike")]
             public bool ExcludeLookAlike { get; set; }
 
-            [JsonProperty(PropertyName = "mostOccurAtMostOnce")]
-            public bool MostOccurAtMostOnce { get; set; }
+            [JsonProperty(PropertyName = "mustOccurAtMostOnce")]
+            public bool MustOccurAtMostOnce { get; set; }
         }
 
         #region Private Members
@@ -100,7 +100,7 @@ public override void KeyPressed(KeyPayload payload)
 
                 profile.ExcludeLookAlike = settings.ExcludeLookAlike;
                 profile.Length = (uint)settings.Length;
-                profile.NoRepeatingCharacters = settings.MostOccurAtMostOnce;
+                profile.NoRepeatingCharacters = settings.MustOccurAtMostOnce;
 
                 PwGenerator.Generate(out pw, profile, null, new CustomPwGeneratorPool());
 

diff --git a/StreamDeck-KeePass/StreamDeck-KeePass/PropertyInspector/KeePassGeneratePI.html b/StreamDeck-KeePass/StreamDeck-KeePass/PropertyInspector/KeePassGeneratePI.html
@@ -47,8 +47,8 @@
                     <label for="excludeLookAlike" class="sdpi-item-label"><span></span>Exclude Look-Alike Characteres</label>
                 </div>
                 <div class="sdpi-item-child">
-                    <input id="mostOccurAtMostOnce" class="sdProperty sdCheckbox" type="checkbox" name="configuration" oninput="setSettings()">
-                    <label for="mostOccurAtMostOnce" class="sdpi-item-label"><span></span>Most Occur at most Once</label>
+                    <input id="mustOccurAtMostOnce" class="sdProperty sdCheckbox" type="checkbox" name="configuration" oninput="setSettings()">
+                    <label for="mustOccurAtMostOnce" class="sdpi-item-label"><span></span>Must Occur at most Once</label>
                 </div>
             </div>
         </div>

diff --git a/StreamDeck-KeePass/StreamDeck-KeePass/PropertyInspector/KeePassRetrievePI.html b/StreamDeck-KeePass/StreamDeck-KeePass/PropertyInspector/KeePassRetrievePI.html
@@ -26,7 +26,7 @@
         <div class="sdpi-item" id="dvField">
             <div class="sdpi-item-label">Select field to retrieve</div>
             <select class="sdpi-item-value select sdProperty" id="field" oninput="setSettings()">
-               <option value="Password">Passwordd</option>
+               <option value="Password">Password</option>
                <option value="Username">Username</option>
                <option value="Notes">Notes</option>
                <option value="URL">URL</option>