Add license and user guide
This commit is contained in:
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 DataLoom contributors
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -7,7 +7,7 @@ Offline desktop application for reviewing and merging Bitwarden exports.
|
|||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
Initial project scaffold and design documentation. Implementation has not started.
|
Working Windows 11 portable release available from the private/public Gitea release page, with synthetic tests and review workflow validated.
|
||||||
|
|
||||||
## Goals
|
## Goals
|
||||||
|
|
||||||
@@ -46,4 +46,8 @@ Python and PySide6/Qt for a desktop application. The initial implementation will
|
|||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
The detailed design is in [`docs/design.md`](docs/design.md). See [`docs/roadmap.md`](docs/roadmap.md) for the planned milestones.
|
The quick-start guide is in [`docs/how-to.md`](docs/how-to.md). The detailed design is in [`docs/design.md`](docs/design.md). See [`docs/roadmap.md`](docs/roadmap.md) for the planned milestones.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
DataLoom is released under the [MIT License](LICENSE).
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# DataLoom quick how-to
|
||||||
|
|
||||||
|
DataLoom reviews and merges unencrypted Bitwarden exports locally on Windows 11.
|
||||||
|
|
||||||
|
## Before you begin
|
||||||
|
|
||||||
|
1. Export your vault from Bitwarden as JSON or CSV.
|
||||||
|
2. Keep the original exports unchanged and work from copies.
|
||||||
|
3. Use the same format for every file in a batch. JSON is recommended because it preserves more Bitwarden data than CSV.
|
||||||
|
4. Never place real exports, merged vaults, or audit logs in this repository.
|
||||||
|
|
||||||
|
## Review and merge
|
||||||
|
|
||||||
|
1. Start `DataLoom.exe`.
|
||||||
|
2. Accept the sensitive-data warning.
|
||||||
|
3. Leave **Enable full secret logging** unchecked unless you deliberately want passwords, TOTP values, notes, and other secrets written to the audit log.
|
||||||
|
4. Select two or more Bitwarden JSON or CSV exports.
|
||||||
|
5. Review the **Import Summary** tab.
|
||||||
|
6. Use **Merged Entries** to see records that will be included.
|
||||||
|
7. Use **Duplicate Review** to inspect flagged groups:
|
||||||
|
- Exact duplicates are removed automatically.
|
||||||
|
- Likely or possible duplicates are shown side by side.
|
||||||
|
- The newest record is recommended when reliable revision dates exist.
|
||||||
|
- Choose a record to keep, or choose **Keep both records**.
|
||||||
|
8. Click **Export merged vault…** and save the output. JSON input produces JSON output; CSV input produces CSV output.
|
||||||
|
9. Verify the generated export before importing it into Bitwarden.
|
||||||
|
|
||||||
|
## Output and audit files
|
||||||
|
|
||||||
|
DataLoom displays the exact locations of the merged export and `dataloom-audit.log`. It does not automatically delete either file. Protect or securely delete them when no longer needed.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
- Mixed JSON/CSV batches are rejected; select files of one format only.
|
||||||
|
- Encrypted exports are rejected; export an unencrypted copy for this offline tool.
|
||||||
|
- CSV may not represent every Bitwarden feature. Read the CSV loss warnings and use JSON when complete preservation matters.
|
||||||
|
- If the application does not open, download the current Windows release and confirm that Windows Defender or another security tool has not blocked it.
|
||||||
Reference in New Issue
Block a user