update readme

README.md

@@ -6,4 +6,51 @@
 [![CI](https://github.com/tlambert03/pyconify/actions/workflows/ci.yml/badge.svg)](https://github.com/tlambert03/pyconify/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/tlambert03/pyconify/branch/main/graph/badge.svg)](https://codecov.io/gh/tlambert03/pyconify)
 
-iconify for python. Universal icon framework
+Python wrapper for the [Iconify](https://github.com/iconify) API.
+
+Iconify is a versatile icon framework that includes 100+ icon sets with more
+than 100,000 icons from FontAwesome, Material Design Icons, DashIcons, Feather
+Icons, EmojiOne, Noto Emoji and many other open source icon sets.
+
+Search for icons at: https://icon-sets.iconify.design
+
+## Installation
+
+```bash
+pip install pyconify
+```
+
+## Usage
+
+```python
+import pyconify
+
+# Info on available collections
+collections = pyconify.collections()
+
+# Info on specific collection(s)
+details = pyconify.collection("fa", "fa-brands")
+
+# Search for icons
+hits = pyconify.search("python")
+
+# Get icon data
+data = pyconify.icon_data("fa-brands", "python")
+
+# Get SVG
+svg = pyconify.svg("fa-brands", "python")
+
+# Get SVG as a temporary file for the session
+file_name = pyconify.temp_svg("fa-brands", "python")
+
+# Get CSS
+css = pyconify.css("fa-brands", "python")
+
+# Keywords
+pyconify.keywords('home')
+
+# API version
+pyconify.iconify_version()
+```
+
+See details for each of these results in the [Iconify API documentation](https://iconify.design/docs/api/queries.html).

src/pyconify/__init__.py

@@ -6,6 +6,7 @@
     __version__ = version("pyconify")
 except PackageNotFoundError:  # pragma: no cover
     __version__ = "uninstalled"
+
 __author__ = "Talley Lambert"
 __email__ = "talley.lambert@gmail.com"
 __all__ = [

src/pyconify/py.typed

@@ -1,5 +0,0 @@
-You may remove this file if you don't intend to add types to your package
-
-Details at:
-
-https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages