Update README.md
authorkittlish <kittlish@users.noreply.github.com>
Tue, 26 Nov 2019 18:21:19 +0000 (13:21 -0500)
committerGitHub <noreply@github.com>
Tue, 26 Nov 2019 18:21:19 +0000 (13:21 -0500)
Added some clarification to help people importing their passwords from places other than Google Chrome, before needing to check the troubleshooting section.

README.md

index 31ccb63e4c73d2a84025c753c362bd6149419948..498e2456310229ee2f190c022d4fd3047fbf2e1a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -72,9 +72,17 @@ By default, it works with the passwords exported from Google Chrome.
       -h, --help            show this help message and exit
       -f FROM_FILE, --from FROM_FILE
       -d DIRECTORY, --directory DIRECTORY, --dir DIRECTORY
-                            Firefox profile directory
+                            [Firefox profile directory](https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data#w_how-do-i-find-my-profile)
       -v, --verbose
 
+### Formatting
+
+For CSV files not exported from Google Chrome, take these formatting rules into consideration:
+
+    1. The CSV must have the headers "url", "username", and "password". Any other columns will be safely ignored.
+    2. The url must be formatted to include all prefixes ("http://", "https://", etc), or ffpass will not be able to read them correctly.
+    3. ffpass does not care if the CSV has quotes around fields, even if some fields have them and others don't.
+
 ## Transfer from Google Chrome to Firefox
 
 Now, Firefox can more accurately import logins saved in Chrome/Chromium on Windows and macOS (including timestamps, deduping, http auth. logins, etc.) so you don't need to use this tool on those operating systems. See File > Import from Another Browser… in Firefox to import.
@@ -165,7 +173,7 @@ ffpass export --to passwords.csv
     
     See [\#17](https://github.com/louisabraham/ffpass/issues/17).
 
-  - Empty url field in Firefox after importing: the urls of the source
+  - Empty url field ("example.com") in Firefox after importing: the urls of the source
     csv file must begin with a scheme (`http://`, `https://`, `ftp://`,
     etc…)