chore: update readme

Author: munezerobagira

.github/workflows/deployment.yaml

@@ -11,7 +11,10 @@ jobs:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
-
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -36,7 +39,12 @@ jobs:
           echo "version=$VERSION" >> $GITHUB_OUTPUT
 
       - name: Build Web
-        run: flutter build web
+        run: flutter build web --release
+      - name: add privacy.html to output
+        run: cp privacy.html build/web/privacy.html
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
 
       - name: Build Android APK
         if: matrix.os == 'ubuntu-latest'
@@ -84,7 +92,7 @@ jobs:
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
           asset_path: build/app/outputs/flutter-apk/app-release.apk
-          asset_name: app-${{ steps.version.outputs.version }}.apk
+          asset_name: passbag-${{ steps.version.outputs.version }}.apk
           asset_content_type: application/vnd.android.package-archive
 
       # - name: Upload Linux Build

.vscode/launch.json

@@ -5,18 +5,18 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "passbags",
+      "name": "passbag",
       "request": "launch",
       "type": "dart"
     },
     {
-      "name": "passbags (profile mode)",
+      "name": "passbag (profile mode)",
       "request": "launch",
       "type": "dart",
       "flutterMode": "profile"
     },
     {
-      "name": "passbags (release mode)",
+      "name": "passbag (release mode)",
       "request": "launch",
       "type": "dart",
       "flutterMode": "release"

README.md

@@ -1,55 +1,134 @@
+# Passbag
 
+_A Cross-Platform Password Strengthening Tool_
 
+## 🚀 Purpose
 
-Transform your weak passwords into super strong password.
+Passbag transforms weak, easy-to-remember passwords into strong, consistent passwords using cryptographic methods. It allows you to reliably regenerate the same secure password anytime, without needing to store it.
 
-## About
+---
 
-This is app help you to generate a strong password. It combines two password to generate a strong password.
+## 💡 Motivation
 
-It is implemented using flutter, so it can run in any platform, wether on mac, ios, android, or in browser.
+Traditional password managers often generate random, complex passwords that are hard to remember and reproduce without syncing tools. **passbag** offers a user-friendly alternative:
 
-## Algorithm
+- Enter two memorable "seed" passwords
+- Combine them using a deterministic algorithm
+- Generate a strong password that you can always recreate
 
-1. Provide your own secret from example secret
-2. Provide your weak password for example mbags
-3. Perfom hashing and encoding for your provided secret and weak password to generat a fixed length strong password
-4. Get your strong password 
+This method allows you to:
 
-- No information is saved in browser or database, you own your own password
+- Avoid password fatigue
+- Maintain strong security hygiene
+- Stay in control of your credentials
 
+---
 
+## 🔐 How It Works
 
+**Current Implementation:**
 
+- **HMAC-SHA256** (via `cryptoHmacSha256`): A secure and widely trusted hashing algorithm
+- **Base64 Encoding**: Converts hashed output into a readable format
 
+### Example Flow:
 
+1. User enters two weak passwords: `pass1` and `pass2`
+2. The tool computes `HMAC_SHA256(pass1, pass2)` using Dart's `cryptoHmacSha256`
+3. The result is base64-encoded
+4. Output is a strong, deterministic password
 
+> The same input pair always produces the same secure output.
 
+---
 
+## ✅ Features
 
+- 🔁 Reproducible strong passwords
+- 🧠 Works with memorable inputs
+- 🌍 Cross-platform (Flutter: mobile, web, and desktop)
+- 🗃️ No password storage required
+- 📶 Works offline
 
+---
 
-A cross-platform password strengthening tool
-[Passbag](./lib/assets/images/logo.png)
-## Purpose
+## 📅 Roadmap & Future Plans
 
-Transforms weak passwords into stronger ones by combining two weak passwords into a single, more secure password using a one-way algorithm.
+### 🔄 Algorithm Flexibility
 
-## Motivation
+- [ ] Support additional hash algorithms (SHA3, BLAKE2, etc.)
+- [ ] Allow custom encoding options (hex, base64url, etc.)
+- [ ] Add salt/pepper configurations for advanced users
 
-Browser password managers often generate random passwords that are hard to reproduce. Passbags solves this by:
+### 🧬 Biometric Integration
 
-- Taking two easy-to-remember passwords as input
-- Combining them using a consistent algorithm
-- Producing the same strong password every time
+- [ ] Enable **fingerprint or face ID** as a third input
+  - Biometric hash included in final password generation
+  - Deterministic per device or stored key
+  - Useful for added security without sacrificing usability
 
-This allows users to:
+### 📱 Platform Support (All via Flutter)
 
-1. Generate strong passwords
-2. Recreate the same password when needed
-3. Keep using simple passwords as seeds
+- [ ] **Mobile apps**: Android & iOS
+- [ ] **Web app**: PWA with offline support
+- [ ] **Desktop app**: Windows, macOS, and Linux (built using Flutter)
 
-## How It Works
+### 🧩 Advanced Customization
 
-Just input two weak passwords, and passbags will combine them into one stronger password that you can reliably regenerate anytime.
+- [ ] Output formatting options:
+  - Custom password length (e.g. 12, 16, 20+ characters)
+  - Define character sets (symbols, upper/lowercase, digits, etc.)
+  - Choose from different output styles (secure hash, passphrase, PIN)
+- [ ] Masked mode to hide password on screen
 
+### 🔐 Custom Output & Encryption Options
+
+- [ ] Ability to define a password schema:
+  - e.g. "16 characters: 4 digits, 4 uppercase, 4 symbols, 4 lowercase"
+- [ ] Option to encrypt the generated password:
+  - With a user-provided passphrase or key
+  - Useful for secure sharing or device-specific protection
+- [ ] Output encryption options:
+  - AES-based encryption with user seed
+  - One-time encryption with QR export
+  - Encrypted backups of input/output pairs (optional and opt-in only)
+
+### 🛡️ Enhanced Security
+
+- [ ] Optional local encryption for input history (if stored)
+- [ ] Integration with vetted crypto libraries (like libsodium)
+- [ ] Cryptographic audit and pen-testing support
+
+### 🧪 Testing & Usability
+
+- [ ] Fuzz tests and unit testing for hashing module
+- [ ] A/B testing for UX improvements
+- [ ] Full accessibility support (screen readers, keyboard-only nav, etc.)
+
+---
+
+## 🧠 Inspired By
+
+A need for secure but memorable passwords, especially when switching devices, working offline, or avoiding over-dependence on cloud-based password managers.
+
+---
+
+## 🛠️ Installation
+
+Coming soon:
+
+- Web demo
+- Android APK & iOS TestFlight
+- Desktop builds (macOS, Windows, Linux)
+
+---
+
+## 🤝 Contributing
+
+Want to help make passbag better?
+
+We're looking for:
+
+- Flutter developers (mobile, web, desktop)
+- Cryptography and security experts
+- UI/UX designers and testers

lib/app.dart

@@ -1,6 +1,6 @@
 import 'package:flutter/material.dart';
-import 'package:passbags/src/features/onboarding/onboarding_screen.dart';
-import 'package:passbags/src/features/password/password_screen.dart';
+import 'package:passbag/src/features/onboarding/onboarding_screen.dart';
+import 'package:passbag/src/features/password/password_screen.dart';
 import 'package:flutter_gen/gen_l10n/app_localizations.dart';
 
 class MyApp extends StatelessWidget {

lib/src/features/onboarding/onboarding_screen.dart

@@ -1,6 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_svg/svg.dart';
-import 'package:passbags/src/features/password/password_screen.dart';
+import 'package:passbag/src/features/password/password_screen.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
 class OnboardingScreen extends StatefulWidget {
@@ -49,7 +49,7 @@ class _OnboardingScreenState extends State<OnboardingScreen> {
 
   final List<Widget> _pages = const [
     OnboardingPage(
-      title: 'Welcome to Passbags',
+      title: 'Welcome to passbag',
       description:
           'Turn your simple passwords into strong ones with Passags - your password strengthening companion!',
       imagePath: 'lib/assets/images/security_1.svg',

lib/src/features/password/password_screen.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
-import "package:passbags/src/utils/password_generator.dart";
+import "package:passbag/src/utils/password_generator.dart";
 import "package:flutter/services.dart";
-import "package:passbags/src/widgets/styled_text_input.dart";
+import "package:passbag/src/widgets/styled_text_input.dart";
 
 class PasswordGeneratorScreen extends StatefulWidget {
   @override

privacy.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Privacy Policy - Passbags</title>
+    <title>Privacy Policy - passbag</title>
     <style>
       body {
         font-family: Arial, sans-serif;
@@ -36,14 +36,14 @@ <h1>Privacy Policy</h1>
     <p>Effective Date: April 16, 2025</p>
 
     <p>
-      Welcome to Passbags! Your privacy is important to us. This Privacy Policy
+      Welcome to passbag! Your privacy is important to us. This Privacy Policy
       explains how we collect, use, and protect your information when you use
       our app.
     </p>
 
     <h2>Information We Collect</h2>
     <p>
-      Passbags does not collect or store any personal information. All data,
+      passbag does not collect or store any personal information. All data,
       including passwords and secrets, is processed locally on your device and
       is not transmitted to any server.
     </p>
@@ -57,7 +57,7 @@ <h2>How We Use Your Information</h2>
 
     <h2>Third-Party Services</h2>
     <p>
-      Passbags does not integrate with any third-party services or analytics
+      passbag does not integrate with any third-party services or analytics
       tools. Your data remains private and secure on your device.
     </p>
 
@@ -83,7 +83,7 @@ <h2>Contact Us</h2>
     </p>
 
     <h2>Developer Information</h2>
-    <p>Passbags is developed and maintained by Sostene Munezero Bagira.</p>
+    <p>passbag is developed and maintained by Sostene Munezero Bagira.</p>
     <div class="social-links">
       Connect with the developer:
       <a href="https://www.linkedin.com/in/sostene/" target="_blank"
@@ -92,6 +92,6 @@ <h2>Developer Information</h2>
       <a href="https://github.com/munezerobagira" target="_blank">GitHub</a>
     </div>
 
-    <p>Thank you for using Passbags!</p>
+    <p>Thank you for using passbag!</p>
   </body>
 </html>

pubspec.yaml

@@ -1,4 +1,4 @@
-name: passbags
+name: passbag
 description: An app that strengthen your password.
 # The following line prevents the package from being accidentally published to
 # pub.dev using `flutter pub publish`. This is preferred for private packages.
@@ -16,7 +16,7 @@ publish_to: "none" # Remove this line if you wish to publish to pub.dev
 # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
 # In Windows, build-name is used as the major, minor, and patch parts
 # of the product and file versions while build-number is used as the build suffix.
-version: 0.0.1+4
+version: 0.0.1+5
 
 environment:
   sdk: ">=3.0.6 <4.0.0"