Merge pull request #10 from zeoflow/docs

improved documentation with the rebased version
zeoflow · Feb 23, 2021 · 2301594 · 2301594
2 parents 8a15377 + 8b31e90
commit 2301594
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -51,8 +51,29 @@ public class MainActivity extends BindAppActivity<ActivityMainBinding, MainViewB
     protected void onCreate(@Nullable Bundle savedInstanceState)
     {
         //..
-        PasswordType res = initializePassChecker()
-            .calculateStrength("password");
+
+        // Create a map of excluded words on a per-user basis using a hypothetical "User" object that contains this info
+        List<Dictionary> dictionaryList = ConfigurationBuilder.getDefaultDictionaries(this);
+        dictionaryList.add(new DictionaryBuilder(this)
+            .setDictionaryName("exclude")
+            .setExclusion(true)
+            .addWord("word", 0)
+            .createDictionary());
+
+        // Create our configuration object and set our custom minimum
+        // entropy, and custom dictionary list
+        Configuration configuration = new ConfigurationBuilder()
+            .setMinimumEntropy(40d)
+            .setDictionaries(dictionaryList)
+            .createConfiguration(this);
+
+        // Create our PasswordChecker object with the configuration we built
+        PasswordChecker passwordChecker = new PasswordChecker(configuration);
+
+        // passwordStrength is of PasswordType type
+        // PasswordType can be (VERY_WEAK, WEAK, MEDIUM, STRONG, VERY_STRONG)
+        PasswordType passwordStrength = passwordChecker.estimate("asdasdssd").getStrength();
+
         //..
     }
     //..

diff --git a/docs/README.md b/docs/README.md
@@ -51,8 +51,29 @@ public class MainActivity extends BindAppActivity<ActivityMainBinding, MainViewB
     protected void onCreate(@Nullable Bundle savedInstanceState)
     {
         //..
-        PasswordType res = initializePassChecker()
-            .calculateStrength("password");
+
+        // Create a map of excluded words on a per-user basis using a hypothetical "User" object that contains this info
+        List<Dictionary> dictionaryList = ConfigurationBuilder.getDefaultDictionaries(this);
+        dictionaryList.add(new DictionaryBuilder(this)
+            .setDictionaryName("exclude")
+            .setExclusion(true)
+            .addWord("word", 0)
+            .createDictionary());
+
+        // Create our configuration object and set our custom minimum
+        // entropy, and custom dictionary list
+        Configuration configuration = new ConfigurationBuilder()
+            .setMinimumEntropy(40d)
+            .setDictionaries(dictionaryList)
+            .createConfiguration(this);
+
+        // Create our PasswordChecker object with the configuration we built
+        PasswordChecker passwordChecker = new PasswordChecker(configuration);
+
+        // passwordStrength is of PasswordType type
+        // PasswordType can be (VERY_WEAK, WEAK, MEDIUM, STRONG, VERY_STRONG)
+        PasswordType passwordStrength = passwordChecker.estimate("asdasdssd").getStrength();
+
         //..
     }
     //..