update readme with use instructions

README.md

@@ -1,42 +1,50 @@
 # NoMail
+
+
 ## Table of Contents
 
 * **[Description](#description)**
 * **[Why?](#why)**
 * **[Usage](#usage)**
 * **[Contributing](#contributing)**
 
+
 ## Description
 
 Customizable email filter for Gmail with Python.
 
+
 ## Why?
 
-I am personally tired of sifting through the deluge of emails I
-receive. I wanted to make a customizable email filter to extract
+I wanted to make a customizable email filter to extract
 pertinent information and ignore the rest.
 
+
 ## Installation
 
-1. Install with [`pip`](https://pypi.org/project/nomail/)
-    + `$ pip install nomail`
+```bash
+pip install nomail
+```
 
 ## Usage
 
-```
-Usage: nomail.py [OPTIONS]
-
-  Filter out the noise.
-  Developed by Aiden Cullo -> (Github: aidencullo)
+`nomail` can be used move emails to your trash:
 
+```python
+import nomail
 
-Options:
-  -v         Display version.
-  -help, -h  Show this message.
+# by default, email addresses in blacklist.csv will be moved to your trash folder
+nomail.filter()
 ```
 
+
 ## Contributing
 
 1. Clone repo and create a new branch: `$ git checkout https://github.com/aidencullo/nomail -b name_for_new_branch`.
 2. Make changes and test
-3. Submit pull request with description of proposed changes
+3. Submit pull request with description of proposed changes
+
+
+## License
+
+`nomail` was created by Aiden Cullo. It is licensed under the terms of the MIT license.

src/nomail/__init__.py

@@ -0,0 +1,10 @@
+# read version from installed package
+from importlib.metadata import version
+__version__ = version("nomail")
+
+__all__ = [
+    'filter',
+]
+
+def filter():
+    print(f'{__name__=}')