loadimg ...

not-lain · Mar 26, 2024 · dd1319b · dd1319b
1 parent bdff13f
commit dd1319b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,15 @@
 # loadimg
 
 a python package for loading images
+## how to use
+installation
+```
+pip install git+https://github.com/not-lain/loadimg
+```
+usage
+```python
+from loadimg import load_img
+load_img(any_img_type_here) # output_type parameter is coming soon
+```
 
 ![loadimg](./loadimg.png)
diff --git a/src/loadimg/utils.py b/src/loadimg/utils.py
@@ -23,7 +23,7 @@ def download_image(url: str):
 SUPPORTED_TYPES = Union[str, np.ndarray, Image.Image]
 
 
-def load_image(
+def load_img(
     img: SUPPORTED_TYPES,
     # output_type=Literal["PIL"]
 ) -> Any: