Skip to content

Commit a6f3793

Browse files
committed
Remove outdated video guide from readme and reorder sections
1 parent b6b23cd commit a6f3793

1 file changed

Lines changed: 8 additions & 13 deletions

File tree

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@ This change was unannounced and no reason was ever released.
2121

2222
fb2cal is a tool which restores this functionality.
2323
It works by calling endpoints that power the https://www.facebook.com/events/birthdays/ page.
24-
After gathering a list of birthdays for all the users friends for a full year, it creates a ICS calendar file. This ICS file can then be imported into third party tools (such as Google Calendar).
24+
After gathering a list of birthdays for all the users friends for a full year, it creates a ICS calendar file. This ICS file can then be imported into third party tools (such as Google Calendar or Apple Calendar).
25+
26+
## Caveats
27+
* Facebook accounts secured with 2FA are currently not supported (see [#9](../../issues/9))
28+
* During Facebook authentication, a security checkpoint may trigger that will force you to change your Facebook password.
2529

2630
## Requirements
2731
* Facebook account
@@ -44,21 +48,9 @@ This tool can be configured by editing the `config/config.ini` configuration fil
4448

4549
<table> <thead> <tr> <th>Section</th> <th>Key</th> <th>Valid Values</th> <th>Description</th> </tr></thead> <tbody> <tr> <td rowspan=2>AUTH</td><td>fb_email</td><td></td><td>Your Facebook login email</td></tr><tr> <td>fb_password</td><td></td><td>Your Facebook login password</td></tr><tr> <td rowspan=2>FILESYSTEM</td><td>save_to_file</td><td>True, False</td><td>If tool should save ICS file to the local file system</td></tr><tr> <td>ics_file_path</td><td></td><td>Path to save ICS file to (including file name)</td></tr><tr> <td>LOGGING</td><td>level</td><td>DEBUG, INFO, WARNING, ERROR, CRITICAL</td><td>Logging level to use. Default: INFO</td></tr></tbody></table>
4650

47-
## Troubleshooting
48-
If you encounter any issues, please open the `config/config.ini` configuration file and set the `LOGGING` `level` to `DEBUG` (it is `INFO` by default). Include these logs when asking for help.
49-
50-
Also make sure to check the **Caveats** section below.
51-
52-
## fb2cal Setup Guide for Non-Devs [Windows]
53-
[![fb2cal Setup Guide for Non-Devs [Windows]](http://img.youtube.com/vi/UnsbV8EJ8-Y/0.jpg)](http://www.youtube.com/watch?v=UnsbV8EJ8-Y "fb2cal Setup Guide for Non-Devs [Windows]")
54-
5551
## Scheduled Task Frequency
5652
It is recommended to run the script **once every 24 hours** to update the ICS file to ensure it is synchronized with the latest Facebook changes (due to friend addition/removal) and to respect the privacy of users who decide to hide their birthday later on. Facebook originally recommended polling for birthday updates **once every 12 hours** based on the `X-PUBLISHED-TTL:PT12H` header included in their ICS files.
5753

58-
## Caveats
59-
* Facebook accounts secured with 2FA are currently not supported (see [#9](../../issues/9))
60-
* During Facebook authentication, a security checkpoint may trigger that will force you to change your Facebook password.
61-
6254
## Testing
6355
1. Set up pipenv environment
6456
`pipenv install`
@@ -67,6 +59,9 @@ It is recommended to run the script **once every 24 hours** to update the ICS fi
6759
3. Run the `unittests` module on the `tests` folder
6860
`pipenv run python -m unittest discover tests`
6961

62+
## Troubleshooting
63+
If you encounter any issues, please open the `config/config.ini` configuration file and set the `LOGGING` `level` to `DEBUG` (it is `INFO` by default). Include these logs when asking for help.
64+
7065
## Contributions
7166
Contributions are always welcome!
7267
Just make a [pull request](../../pulls).

0 commit comments

Comments
 (0)