Update README.md

README.md

@@ -8,3 +8,37 @@ sdk: docker
 pinned: false
 license: apache-2.0
 ---
+
+Gradio Custom Component to integrate the great [Pannellum](https://pannellum.org/) library, a lightweight, free, and open source panorama viewer for the web.
+
+**Installation:**
+
+```
+pip install gradio-pannellum
+```
+
+**Usage:**
+
+```py
+
+import gradio as gr
+from gradio_pannellum import Pannellum
+
+
+example = Pannellum().example_inputs()
+
+demo = gr.Interface(
+    lambda x:x,
+    Pannellum(),  # interactive version of your component
+    Pannellum(),  # static version of your component
+    examples=[[example]],
+)
+
+
+demo.launch()
+```
+
+**Screenshot:**
+
+![](https://huggingface.co/spaces/Wauplin/gradio_pannellum/resolve/main/screenshot.png)
+