feat(README): add documentation

2018-04-09 16:03:25 +02:00
parent d05c9b6133
commit 5cca58f2b3
1 changed files with 13 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -12,6 +12,19 @@ Installation of the [npm package](https://npmjs.org/package/xo-import-servers-cs

 ## Usage

+`servers.csv`:
+
+```csv
+host,username,password
+xs1.company.net,user1,password1
+xs2.company.net:8080,user2,password2
+http://xs3.company.net,user3,password3
+```
+
+> The CSV file can also contains these optional fields: `label`, `autoConnect`, `allowUnauthorized`.
+
+Shell command:
+
 ```
 > xo-import-servers-csv 'https://xo.company.tld' admin@admin.net admin < servers.csv
 ```