initial commit

README.md

@@ -0,0 +1,49 @@
+# Bitwarden Markdown Generator
+
+This Python script converts a Bitwarden JSON export file into a formatted Markdown file. It organizes password entries by folder and includes details such as creation date, modification date, username, password, and notes.
+
+## Features
+
+- Converts Bitwarden JSON export to Markdown format.
+- Organizes entries by folder.
+- Includes detailed information for each entry.
+- Easy to use and customize.
+
+## Requirements
+
+- Python 3.x
+- uv dependency manager
+
+## Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/gurix/bitwarden-md-generator.git
+   cd bitwarden-md-generator
+   ```
+
+2. Install the required dependencies using `uv`:
+
+   ```bash
+   uv sync
+   ```
+
+## Usage
+
+1. Export your Bitwarden vault as a JSON file.
+
+2. Update the `json_file_path` and `output_md_path` variables in the `main` function of the script to point to your Bitwarden JSON file and the desired output Markdown file location.
+
+3. Run the script:
+
+   ```bash
+   uv run app.py
+   ```
+
+4. Check the specified output directory for the generated Markdown file.
+
+## Customization
+
+- You can modify the `format_date` function to change the date format in the output.
+- Adjust the Markdown template in the `generate` method to include or exclude specific details.