diff --git a/README.md b/README.md index 505a2fa..a6d5e48 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Python 3 script to dump company employees from XING API. The results contain firstname, lastname, position, gender, location and a user's profile link. Only 2 API calls are required to retrieve all employees. -With the `--full` CLI flag an additional API request will be made for each employee to retrieve contact details such as email, fax, mobile and phone number. However, this data is most often unset by XING users. With the `--mail-format` CLI flag one can define a Python string format to auto generate email addresses based on the retrieved first and last name. +With the `--full` CLI flag an additional API request will be made for each employee to retrieve contact details such as email, fax, mobile and phone number. However, this data is most often unset by XING users. With the `--email-format` CLI flag one can define a Python string format to auto generate email addresses based on the retrieved first and last name. ## How-To 1. Sign into www.xing.com and retrieve your ``login`` cookie value e.g. via developer tools @@ -34,7 +34,7 @@ options: ## Docker Run Examples ```` -docker run --rm l4rm4nd/xingdumper:latest --url --cookie --mail-format '{0}.{1}@example.com' +docker run --rm l4rm4nd/xingdumper:latest --url --cookie --email-format '{0}.{1}@example.com' ```` ## Examples @@ -45,7 +45,7 @@ python3 xingdumper.py --url https://www.xing.com/pages/audiag --quiet' > audi_em ```` Dumping 10 Apple employees from XING API with additional contact details as terminal output and auto generate email with provided string format:: ```` -python3 xingdumper.py --url https://www.xing.com/pages/appleretaildeutschlandgmbh --count 10 --full --mail-format '{0}.{1}@apple.de' +python3 xingdumper.py --url https://www.xing.com/pages/appleretaildeutschlandgmbh --count 10 --full --email-format '{0}.{1}@apple.de' ```` **Note**: Contact details are most often empty. We Germans take privacy seriously! Further, the details may only be accessible if you already belong to the contact list of the crawled employee. Kinda unlikely, however the default privacy settings of XING would allow a retrival, if the data is configured and the privacy settings not changed by the user.