Skip to content

Commit 2f84d9c

Browse files
authored
Merge pull request #117 from mobeigi/update-documentation-for-1-3-0
Update readme for 1.3.0
2 parents c850987 + 3f92c71 commit 2f84d9c

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,32 @@ After gathering a list of birthdays for all the users friends for a full year, i
3333
* pipenv
3434
* Scheduler tool to automatically run script periodically (optional)
3535

36+
## PyPi Project
37+
https://pypi.org/project/fb2cal/
38+
3639
## Instructions
40+
41+
### PyPi (Recommended)
42+
1. In an empty folder of your choice, set up pipenv environment
43+
`pipenv install`
44+
2. Install `fb2cal` module:
45+
`pipenv run pip install fb2cal`
46+
3. Download [config/config-template.ini](https://raw.githubusercontent.com/mobeigi/fb2cal/master/config/config-template.ini) file and store it in `config/config.ini`.
47+
4. Update the `config/config.ini` file and enter your Facebook email and password (no quotes).
48+
5. Run the `fb2cal` module
49+
`pipenv run python -m fb2cal`
50+
6. Check the output folder (`out` by default) for the created `birthdays.ics` file
51+
52+
### Local
3753
1. Clone repo
3854
`git clone git@github.com:mobeigi/fb2cal.git`
39-
2. Rename `config/config-template.ini` to `config/config.ini` and enter your Facebook email and password (no quotes).
40-
3. Set up pipenv environment
55+
2. Copy `config/config-template.ini` to `config/config.ini`.
56+
3. Update the `config/config.ini` file and enter your Facebook email and password (no quotes).
57+
4. Set up pipenv environment
4158
`pipenv install`
42-
4. Run the `fb2cal` module
59+
5. Run the `fb2cal` module
4360
`pipenv run python -m fb2cal`
44-
5. Check the output folder (`out` by default) for the created `birthdays.ics` file
61+
6. Check the output folder (`out` by default) for the created `birthdays.ics` file
4562

4663
## Configuration
4764
This tool can be configured by editing the `config/config.ini` configuration file.

0 commit comments

Comments
 (0)