Skip to content

Commit f276102

Browse files
authored
Merge pull request #70 from owenong1/branch-updateUG1.3
UG update for 1.3.1 release
2 parents 596fe2e + 346ee06 commit f276102

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

docs/UserGuide.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,14 +225,34 @@ Format: `clear`
225225

226226
### Importing contacts from .csv : `import`
227227

228-
Imports all contacts from ./import/import.csv
229-
Format: `import`
230-
* Requires a file named import.csv to be present at `./import`
228+
Imports all contacts from given file path (default ./import/import.csv)
229+
230+
Format: `import f/PATH`
231+
232+
* Requires a valid file to be given in the PATH variable
233+
* If PATH is left empty (i.e. `import f/`) the default file referenced is ./import/import.csv
231234
* The format of the first line of the csv should be:
232-
NAME | NUMBER | EMAIL | ADDRESS | TAG
233-
with no spacing. The titles are non-caps sensitive.
234-
* The format of each subsequent line should follow the appropriate add command format.
235+
`NAME | NUMBER | EMAIL | ADDRESS | TAG`
236+
Here the `|` character specifies a new cell.
237+
* There should be no trailing empty characters (' ') in any cell.
238+
* The titles are non-caps sensitive (`Name` pr `NaME` would also be valid)
239+
* The format of each parameter should follow the appropriate add command format.
235240
* There should be no blank lines, and no conflicts with contacts in the existing address book
241+
* The `TAG` portion accepts multiple tags delimited by the `|` character (e.g. Friend|Colleague)
242+
243+
Examples:
244+
* `import f/./import/import.csv` imports the contacts from the specified file
245+
246+
### Exporting contacts from address book : `export`
247+
248+
Exports all contacts to ./export/export.csv
249+
250+
Format: `export`
251+
252+
* If a file export.csv is already present at ./export, it will be overwritten with the
253+
current address book data
254+
* The export file format is the same as the output format given in `import`
255+
236256

237257
### Exiting the program : `exit`
238258

0 commit comments

Comments
 (0)