Skip to content

Commit 4739963

Browse files
committed
Updated readme, installation instructions
1 parent a188dde commit 4739963

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,32 @@
22

33
`safarireadinglist` is a Python package to load your Safari reading list into Python, and to export it, including thumbnail icons.
44

5-
<img src="readme_imgs/reading_list.jpg" alt="drawing" width="400"/>
5+
<img src="https://github.com/smrfeld/export-safari-reading-list/blob/main/readme_imgs/reading_list.jpg?raw=true" alt="drawing" width="400"/>
66

77
## Sample results
88

9-
<img src="readme_imgs/json.png" alt="drawing" width="700"/>
9+
<img src="https://github.com/smrfeld/export-safari-reading-list/blob/main/readme_imgs/json.png?raw=true" alt="drawing" width="700"/>
1010

11-
<img src="readme_imgs/csv.png" alt="drawing" width="700"/>
11+
<img src="https://github.com/smrfeld/export-safari-reading-list/blob/main/readme_imgs/csv.png?raw=true" alt="drawing" width="700"/>
1212

1313
## Installation
1414

15-
Install the `safarireadinglist` package in the root directory.
15+
Install the `safarireadinglist` package from PyPI:
16+
17+
```bash
18+
pip install safarireadinglist
19+
```
20+
21+
Note: before using, you need to give the terminal full disk access in the system preferences. Go to `Settings/Security & Privacy/Full Disk Access`. Navigate to `/Applications/Utilities/` folder and choose the `Terminal` app. If you are launching the command from VS Code you will need to add this as well.
22+
23+
*Alternative local installation:*
1624

1725
```bash
1826
pip install -e .
1927
```
2028

2129
Note: `setuptools` is the only requirement. For dev purposes, you may want to install the exact versions in `pip install -r requirements.txt`.
2230

23-
Final note: You need to give the terminal full disk access in the system preferences. See common errors below for instructions.
24-
2531
## Usage
2632

2733
In the command line, execute:
@@ -59,7 +65,7 @@ python website.py reading_list.json reading_list_icons
5965
```
6066
The output is in the `website_out` folder.
6167

62-
<img src="readme_imgs/website.png" alt="drawing" width="800"/>
68+
<img src="https://github.com/smrfeld/export-safari-reading-list/blob/main/readme_imgs/website.png?raw=true" alt="drawing" width="800"/>
6369

6470
## Known errors & solutions
6571

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setup(
77
name="safarireadinglist",
8-
version="0.1.0",
8+
version="0.1.1",
99
author="Oliver K. Ernst",
1010
description="Safari reading list",
1111
long_description=long_description,

0 commit comments

Comments
 (0)