Skip to content

Commit c4ebe38

Browse files
Matthew PhillipsMatthew Phillips
Matthew Phillips
authored and
Matthew Phillips
committed
made the usage directions a little simpler
1 parent 9d0c8e1 commit c4ebe38

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
##pyfav
22

33

4-
pyfav is a simple Python library that helps you get a [favicon](http://en.wikipedia.org/wiki/Favicon) for a supplied URL.
4+
pyfav is a Python library that helps you get a [favicon](http://en.wikipedia.org/wiki/Favicon) for a supplied URL.
55

66
Favicons can be annoying to track down because they're commonly located in a handful of different places. pyfav removes the annoyance by handling the details for you -- you supply a URL and pyfav will give you the favicon.
77

@@ -21,6 +21,10 @@ favicon_saved_at = download_favicon('https://www.python.org/')
2121
You should now see the favicon in your /tmp directory. If you want to control where the favicon gets written to disk,
2222

2323
````
24+
from pyfav import download_favicon
25+
26+
mkdir /tmp/favicon-downloads
27+
2428
favicon_saved_at = download_favicon('https://www.python.org/', \
2529
file_prefix='python.org-', target_dir='/tmp/favicon-downloads')
2630
````

README.rst

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ control where the favicon gets written to disk,
2626

2727
::
2828

29+
from pyfav import download_favicon
30+
31+
mkdir /tmp/favicon-downloads
32+
2933
favicon_saved_at = download_favicon('https://www.python.org/', \
3034
file_prefix='python.org-', target_dir='/tmp/favicon-downloads')
3135

0 commit comments

Comments
 (0)