Skip to content

Commit 4f1758f

Browse files
committed
Update README.md
1 parent b6fe49c commit 4f1758f

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Utility for retrieving favicons and other site-related icons for a given URL
33

44
## Description
5-
The purpose of _ficonic_ is to download all icons intended for use in identifying a site at a given URL. This allows the user to select the icon best suited for the medium through which they intend to identify the site.
5+
The immediate purpose of _ficonic_ is to enable download of all icons provided for identifying a site at a given URL. This allows the user to select the icon best suited for the medium through which they intend to identify the site. The longer term goal is to provide a library for loading data for all of the aforementioned icons into a C++ application for manipulation and/or use as needed.
66

77
_ficonic_ downloads `favicon.ico` and `apple-touch-icon.png` files where found in the site's root directory and any icons identified in HTML `link` tags having recognized `rel` values.
88

@@ -21,7 +21,14 @@ The following libraries are required:
2121
* htmlcxx
2222

2323
## To Do
24+
_(in no particular order...)_
2425
* Handle HTML `meta` tags referring to Microsoft tiles.
2526
* Handle Progressive Web App manifests referring to icons.
2627
* Resolve build warnings about `MAGICKCORE_QUANTUM_DEPTH` and `MAGICKCORE_HDRI_ENABLE`.
27-
* Enable use of `$HOME` and `~` to refer to the home directory in specifying the icon storage directory path.
28+
* Enable use of `$HOME` and `~` to refer to the home directory in specifying the icon storage directory path.
29+
* Add user-friendly error messages for missing required arguments.
30+
* Update help information to indicate what arguments are required.
31+
* Clean up console output to improve usability.
32+
* Handle `.gif` icon files.
33+
* Add error handling to skip unsupported file types.
34+
* Create and save icons to a different directory for each URL from which icons are retrieved.

0 commit comments

Comments
 (0)