Doc updates for new release

SuperioOne · Apr 5, 2024 · 524ff44 · 524ff44
1 parent e3937e0
commit 524ff44
Show file tree

Hide file tree

Showing 17 changed files with 101 additions and 120 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,24 @@
+## v0.3.0 - April 05, 2024
+----------------
+
+## Added
+
+- Profile database backup and restore support.
+- Visible log panel button at the footer section. In previous versions, It was only accessible with `Ctrl` + `I` shortcut.
+- Version information at the footer section.
+
+## Changed
+
+- `--log_level` flag name changed to `--verbose`. App can now be started as `keywich --verbose debug`.
+
+## Fixes
+
+- Profile databases cannot be initialized with certain master passwords.
+
+## Deleted
+
+- CLI password generator sub-command deleted.
+
 # v0.2.0 - March 14, 2024
 ----------------
 
@@ -18,4 +39,4 @@
 - On Linux, `webkit2gtk >= 2.42.x` when used with Nvidia proprietary drivers, may display an empty window
   with the error message `KMS: DRM_IOCTL_MODE_CREATE_DUMB failed: Permission denied`. Current known solutions are:
     - Set `WEBKIT_DISABLE_DMABUF_RENDERER=1` environment variable.
-    - Enable `nvidia.drm_modeset=1` kernel parameters.
+    - Enable `nvidia.drm_modeset=1` kernel parameters.
diff --git a/README.md b/README.md
@@ -13,36 +13,4 @@ algorithm to create reproducible passwords with the specified length and charact
 
 <br>
 
-```
- Application architecture overview      
-                                                                  
- ┌───────────────────┐     ┌──────────────────┐                                     
- │ OS Keyring        │     │ Profile Database │                                     
- │                   │     │                  │                                     
- │ - Master Password │     │ - Charsets       │                                     
- └─────────┬─────────┘     │ - Domains        │                                     
-           │               │ - Usernames      │                                     
-           │               │ - Tags           │                                     
-           │               └────────┬─────────┘                                     
-           │                        │                                               
-           └─────────┐    ┌─────────┘                                               
-                     │    │                                  Input in, password out 
-                     ▼    ▼                                  Nothing stored         
- ┌────────────────────────────────────────────┐              ┌───────────────┐      
- │                 Tauri App                  │              │    CLI App    │      
- └─────────────────────┬──────────────────────┘              └───────┬───────┘      
-                       │                                             │              
-                       └───────┐                 ┌───────────────────┘              
-                               │                 │                                  
-                               │                 │                                  
-                               ▼                 ▼                                  
- ┌───────────────────────────────────────────────────────────────────────────┐      
- │                               Keywich Password                            │      
- │                                  Generator                                │      
- └─────────────────────────────────────┬─────────────────────────────────────┘      
-                                       │                                            
-                                       ▼                                            
-                             ┌────────────────────┐                                 
-                             │ Generated Password │                                 
-                             └────────────────────┘                                 
-```
+![application screen views](./docs/src/images/screens.webp)
diff --git a/aur/PKGBUILD b/aur/PKGBUILD
@@ -1,7 +1,7 @@
 # Maintainer: Timur Olur <[email protected]>
 
 pkgname=keywich
-pkgver=0.2.0
+pkgver=0.3.0
 pkgrel=1
 pkgdesc='Password generator CLI/GUI application.'
 url='https://github.com/SuperioOne/keywich/'

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -9,6 +9,7 @@
     - [Key Parameters](./key_parameters.md)
     - [Settings](./settings.md)
     - [Shortcuts](./shortcuts.md)
-    - [CLI](./cli.md)
+    - [Backup/Restore](./backup.md)
 - [Changelog](./changelog.md)
-    - [v0.2.0](./changelogs/v0_2_0.md)
+    - [v0.3.0](./changelog/v0_3_0.md)
+    - [v0.2.0](./changelog/v0_2_0.md)
diff --git a/docs/src/backup.md b/docs/src/backup.md
@@ -0,0 +1,28 @@
+# Backup/Restore
+
+The application's profile database can be exported into a backup file, which contains the following:
+
+* Keys
+* Charsets
+* Custom key icons
+
+## Backing Up Your Keys
+
+1. Open **Settings** > **Backup/Restore** menu.
+2. Click on the **Backup** button and save the file.
+
+## Restoring Your Keys
+
+Please note that restoring from a backup will **OVERRIDE** all of your profile database. Due to the possibility of a gap between the time of the backup and the restore, any modifications made after the backup file was created may be lost. Therefore, it's best practice to create a backup before performing a restore operation.
+
+For restoring from a backup:
+
+1. Open **Settings** > **Backup/Restore** menu.
+2. Click on the **Restore** button.
+3. Select your backup (`.kb`) file and confirm the restore.
+
+<div class="warning">
+
+> All backup files are signed with your master password. If your current master password does not match the backup's signature, the application will display a warning. You can still restore from a backup with a different signature, but the generated passwords will not be the same as the backup source.
+
+</div>
diff --git a/docs/src/chad b/docs/src/chad
diff --git a/docs/src/changelog.md b/docs/src/changelog.md
@@ -1,3 +1,4 @@
 # Changelogs
 
-- [**v0.2.0** - *March 14, 2024*](./changelogs/v0_2_0.md)
+- [**v0.3.0** - *April 05, 2024*](./changelog/v0_3_0.md)
+- [**v0.2.0** - *March 14, 2024*](./changelog/v0_2_0.md)
diff --git a/docs/src/changelogs/v0_2_0.md → docs/src/changelog/v0_2_0.md b/docs/src/changelogs/v0_2_0.md → docs/src/changelog/v0_2_0.md
@@ -24,4 +24,4 @@
 - On Linux, `webkit2gtk >= 2.42.x` when used with Nvidia proprietary drivers, may display an empty window
   with the error message `KMS: DRM_IOCTL_MODE_CREATE_DUMB failed: Permission denied`. Current known solutions are:
     - Set `WEBKIT_DISABLE_DMABUF_RENDERER=1` environment variable.
-    - Enable `nvidia.drm_modeset=1` kernel parameters.
+    - Enable `nvidia.drm_modeset=1` kernel parameters.
diff --git a/docs/src/changelog/v0_3_0.md b/docs/src/changelog/v0_3_0.md
@@ -0,0 +1,26 @@
+# v0.3.0
+----------------
+
+<div align="right">
+
+*April 05, 2024*
+
+</div>
+
+## Added
+
+- Profile database backup and restore support.
+- Visible log panel button at the footer section. In previous versions, It was only accessible with `Ctrl` + `I` shortcut.
+- Version information at the footer section.
+
+## Changed
+
+- `--log_level` flag name changed to `--verbose`. App can now be started as `keywich --verbose debug`.
+
+## Fixes
+
+- Profile databases cannot be initialized with certain master passwords.
+
+## Deleted
+
+- CLI password generator sub-command deleted.
diff --git a/docs/src/cli.md b/docs/src/cli.md
diff --git a/docs/src/images/app_screens.webp b/docs/src/images/app_screens.webp
diff --git a/docs/src/images/screens.webp b/docs/src/images/screens.webp
diff --git a/docs/src/images/theme.gif b/docs/src/images/theme.gif
diff --git a/docs/src/installation.md b/docs/src/installation.md
@@ -1,10 +1,10 @@
 # Installation
 
-See [GitHub release page](https://github.com/SuperioOne/keywich/releases/tag/v0.2.0) for the all available binaries.
+See [GitHub release page](https://github.com/SuperioOne/keywich/releases/tag/v0.3.0) for the all available binaries.
 
 ## Linux x86_64 (.deb)
 
-1. Download [`.deb`](https://github.com/SuperioOne/keywich/releases/download/v0.2.0/keywich_0.2.0_amd64.deb) package
+1. Download [`.deb`](https://github.com/SuperioOne/keywich/releases/download/v0.3.0/keywich_0.3.0_amd64.deb) package
    from GitHub release page.
 
 2. Use `dpkg` to install the package.
@@ -17,7 +17,7 @@ dpkg -i keywich_0.1.0_amd64.deb
 
 PKGBUILD is created but not added to AUR yet.
 
-1. Download [`PKGBUILD`](https://github.com/SuperioOne/keywich/releases/download/v0.2.0/PKGBUILD) file
+1. Download [`PKGBUILD`](https://github.com/SuperioOne/keywich/releases/download/v0.3.0/PKGBUILD) file
    from GitHub release page.
 
 2. Use `makepkg` tool to install the package.
@@ -28,7 +28,7 @@ makepkg --install
 
 ## Windows x86_64
 
-Download [`.msi`](https://github.com/SuperioOne/keywich/releases/download/v0.2.0/Keywich_0.2.0_x64_en-US.msi) installer
+Download [`.msi`](https://github.com/SuperioOne/keywich/releases/download/v0.3.0/Keywich_0.3.0_x64_en-US.msi) installer
 package and execute it.
 
 ## From source
@@ -50,4 +50,4 @@ pnpm run build:desktop
 
 # build output dir
 cd ./tauri_app/target/release
-```
+```
diff --git a/docs/src/introduction.md b/docs/src/introduction.md
@@ -15,40 +15,4 @@ algorithm to create reproducible passwords with the specified length and charact
 
 <br>
 
-![application screen views](./images/app_screens.webp)
-
-```
- Application architecture overview      
-                                                                  
- ┌───────────────────┐     ┌──────────────────┐                                     
- │ OS Keyring        │     │ Profile Database │                                     
- │                   │     │                  │                                     
- │ - Master Password │     │ - Charsets       │                                     
- └─────────┬─────────┘     │ - Domains        │                                     
-           │               │ - Usernames      │                                     
-           │               │ - Tags           │                                     
-           │               └────────┬─────────┘                                     
-           │                        │                                               
-           └─────────┐    ┌─────────┘                                               
-                     │    │                                  Input in, password out 
-                     ▼    ▼                                  Nothing stored         
- ┌────────────────────────────────────────────┐              ┌───────────────┐      
- │                 Tauri App                  │              │    CLI App    │      
- └─────────────────────┬──────────────────────┘              └───────┬───────┘      
-                       │                                             │              
-                       └───────┐                 ┌───────────────────┘              
-                               │                 │                                  
-                               │                 │                                  
-                               ▼                 ▼                                  
- ┌───────────────────────────────────────────────────────────────────────────┐      
- │                               Keywich Password                            │      
- │                                  Generator                                │      
- └─────────────────────────────────────┬─────────────────────────────────────┘      
-                                       │                                            
-                                       ▼                                            
-                             ┌────────────────────┐                                 
-                             │ Generated Password │                                 
-                             └────────────────────┘                                 
-```
-
-
+![application screen views](./images/screens.webp)
diff --git a/docs/src/settings.md b/docs/src/settings.md
@@ -19,4 +19,12 @@ Here's an example of a `config.json` file:
   "is_light_theme": false
 }
 ```
+<br/>
 
+<div align="center">
+
+  ![app themes](./images/theme.gif)
+
+  *Example themes*
+
+</div>
diff --git a/gui/src/routes/(app)/+layout.svelte b/gui/src/routes/(app)/+layout.svelte
@@ -151,17 +151,17 @@
     >
       <div>
         {#if data.version}
-          <button class="text-sm" on:click|preventDefault={open_browser}>
+          <button class="text-xs" on:click|preventDefault={open_browser}>
             v{data.version}
           </button>
         {/if}
       </div>
       <div>
         <button
-          class="btn btn-sm text-sm font-light"
+          class="btn btn-sm text-xs font-light"
           on:click={() => logPanelStore.flip()}
         >
-          <ActivityIcon size={16} />
+          <ActivityIcon size={14} />
           <span>
             {$i18nStore.get_key("i18:/log-panel/title", "Logs")}
           </span>