Add a page explaining the required Wordlist format

This commit is contained in:
Artem Chepurnoy 2024-01-14 13:10:33 +02:00
parent fbbe27d4bc
commit 37cd25ba66
No known key found for this signature in database
GPG Key ID: FAC37D0CF674043E
2 changed files with 35 additions and 0 deletions

View File

@ -12,9 +12,11 @@ import androidx.compose.foundation.lazy.items
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.outlined.Add
import androidx.compose.material.icons.outlined.Book
import androidx.compose.material.icons.outlined.HelpOutline
import androidx.compose.material3.Checkbox
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.Icon
import androidx.compose.material3.IconButton
import androidx.compose.material3.LocalTextStyle
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Text
@ -38,7 +40,9 @@ import com.artemchep.keyguard.common.model.getOrNull
import com.artemchep.keyguard.feature.EmptyView
import com.artemchep.keyguard.feature.ErrorView
import com.artemchep.keyguard.feature.home.vault.component.rememberSecretAccentColor
import com.artemchep.keyguard.feature.navigation.LocalNavigationController
import com.artemchep.keyguard.feature.navigation.NavigationIcon
import com.artemchep.keyguard.feature.navigation.NavigationIntent
import com.artemchep.keyguard.res.Res
import com.artemchep.keyguard.ui.AvatarBuilder
import com.artemchep.keyguard.ui.DefaultFab
@ -110,6 +114,22 @@ fun WordlistScreen(
NavigationIcon()
},
scrollBehavior = scrollBehavior,
actions = {
val navigationController by rememberUpdatedState(LocalNavigationController.current)
IconButton(
onClick = {
val intent = NavigationIntent.NavigateToBrowser(
url = "https://github.com/AChep/keyguard-app/blob/master/wiki/WORDLISTS.md",
)
navigationController.queue(intent)
},
) {
Icon(
imageVector = Icons.Outlined.HelpOutline,
contentDescription = null,
)
}
},
)
},
bottomBar = {

15
wiki/WORDLISTS.md Normal file
View File

@ -0,0 +1,15 @@
# Wordlists
Keyguard allows you to add your own Wordlists to later use them during the Passphrase and Username generation.
**File format**:
The supported file extensions are .txt and .wordlist.
The file should be a text file, with each word being on its own line.
Each line that is either empty or starts from '#', ';', '-', '/' will be ignored.
_Note: Keyguard will incorrectly calculate the Passphrase's strength when using custom wordlists._
### Honorable Wordlists
- [18325 words based on Ngram frequency data](https://github.com/sts10/generated-wordlists/blob/main/lists/1password-replacement/1password-replacement.txt), created by [sts10](https://github.com/sts10).