From 9439e42cdbd9839ba7d5e65bacd893d2d0c57980 Mon Sep 17 00:00:00 2001
From: Markus Birth <mbirth@gmail.com>
Date: Sun, 22 Aug 2021 15:46:04 +0200
Subject: [PATCH] Updated README.

---
 README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)

diff --git a/README.md b/README.md
index 06fbad2..bb69685 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,95 @@ Run converter
 -------------
 
     pipenv run ./convert.py infile.1pif
+
+
+Basic 1Password 1PIF structure
+------------------------------
+
+```json
+{
+    'contentsHash': 'cf89d854',
+    'createdAt': 1617646219,
+    'location': 'https://domain.com/',
+    'locationKey': 'domain.com',
+    'openContents': {
+        'tags': ['Tag1', 'Tag2']
+    },
+    'secureContents': {
+        'URLs': [
+            {'label': 'website', 'url': 'https://domain.com/'}
+        ],
+        'fields': [
+            {
+                'designation': 'username',
+                'name': 'username',
+                'type': 'T',
+                'value': 'john.doe'
+            },
+            {
+                'designation': 'password',
+                'name': 'password',
+                'type': 'P',
+                'value': 'ultrasecurepassword'
+            }
+        ],
+        'notesPlain': 'This is a note.',
+        'sections': [
+            {
+                'fields': [
+                    {
+                        'inputTraits': {'autocapitalization': 'Words'},
+                        'k': 'string',
+                        'n': 'org_name',
+                        't': 'group',
+                        'v': 'My Organisation'
+                    },
+                    {
+                        'inputTraits': {'autocapitalization': 'Words'},
+                        'k': 'string',
+                        'n': 'member_name',
+                        't': 'member name',
+                        'v': 'John Doe'
+                    }
+                ]
+                'name': '',
+                'title': ''
+            },
+            {
+                'name': 'linked items',
+                'title': 'Related Items'
+                // no "fields" structure = empty section
+            }
+        ]
+    },
+    'scope': 'Never',
+    'securityLevel': 'SL5',
+    'title': 'My secret password',
+    'typeName': 'webforms.WebForm',
+    'updatedAt': 1618176026,
+    'uuid': 'ysd77pxq4zghhodfbo47cewudy'}
+ ```
+
+Fields inside sections can be of various types: text, url, email, address, date, month/year, otp, password or a phone number.
+
+Also there are different typeName values that define different field presets.
+
+
+Basic KeePass structure
+-----------------------
+
+```
+- UUID
+- Title
+- UserName
+- Password
+- URL
+- Tags
+- IconID
+- Times
+- History
+- Notes
+- custom fields
+```
+
+Default fields are text. Custom fields can also only be of type text - either hidden (password field) or not.