Update readme to accommodate new changes in docs

wp-cli · Apr 3, 2024 · c1dd85e · c1dd85e
1 parent d522b06
commit c1dd85e
Showing 1 changed file with 61 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,34 @@ Inspects oEmbed providers, clears embed cache, and more.
 wp embed
 ~~~
 
+**EXAMPLES**
 
+    # Get embed HTML for a given URL.
+    $ wp embed fetch https://www.youtube.com/watch?v=dQw4w9WgXcQ
+    <iframe width="525" height="295" src="https://www.youtube.com/embed/dQw4w9WgXcQ?feature=oembed" ...
+
+    # Find cache post ID for a given URL.
+    $ wp embed cache find https://www.youtube.com/watch?v=dQw4w9WgXcQ --width=500
+    123
+
+    # List format,endpoint fields of available providers.
+    $ wp embed provider list
+    +------------------------------+-----------------------------------------+
+    | format                       | endpoint                                |
+    +------------------------------+-----------------------------------------+
+    | #https?://youtu\.be/.*#i     | https://www.youtube.com/oembed          |
+    | #https?://flic\.kr/.*#i      | https://www.flickr.com/services/oembed/ |
+    | #https?://wordpress\.tv/.*#i | https://wordpress.tv/oembed/            |
+
+    # List id,regex,priority fields of available handlers.
+    $ wp embed handler list --fields=priority,id
+    +----------+-------------------+
+    | priority | id                |
+    +----------+-------------------+
+    | 10       | youtube_embed_url |
+    | 9999     | audio             |
+    | 9999     | video             |
+    +----------+-------------------+
 
 
 
@@ -96,7 +123,20 @@ Retrieves oEmbed providers.
 wp embed provider
 ~~~
 
+**EXAMPLES**
 
+    # List format,endpoint fields of available providers.
+    $ wp embed provider list
+    +------------------------------+-----------------------------------------+
+    | format                       | endpoint                                |
+    +------------------------------+-----------------------------------------+
+    | #https?://youtu\.be/.*#i     | https://www.youtube.com/oembed          |
+    | #https?://flic\.kr/.*#i      | https://www.flickr.com/services/oembed/ |
+    | #https?://wordpress\.tv/.*#i | https://wordpress.tv/oembed/            |
+
+    # Get the matching provider for the URL.
+    $ wp embed provider match https://www.youtube.com/watch?v=dQw4w9WgXcQ
+    https://www.youtube.com/oembed
 
 
 
@@ -196,7 +236,16 @@ Retrieves embed handlers.
 wp embed handler
 ~~~
 
+**EXAMPLES**
 
+    # List id,regex,priority fields of available handlers.
+    $ wp embed handler list --fields=priority,id
+    +----------+-------------------+
+    | priority | id                |
+    +----------+-------------------+
+    | 10       | youtube_embed_url |
+    | 9999     | audio             |
+    | 9999     | video             |
 
 
 
@@ -259,7 +308,19 @@ Finds, triggers, and deletes oEmbed caches.
 wp embed cache
 ~~~
 
+**EXAMPLES**
+
+    # Find cache post ID for a given URL.
+    $ wp embed cache find https://www.youtube.com/watch?v=dQw4w9WgXcQ --width=500
+    123
+
+    # Clear cache for a post.
+    $ wp embed cache clear 123
+    Success: Cleared oEmbed cache.
 
+    # Triggers cache for a post.
+    $ wp embed cache trigger 456
+    Success: Caching triggered!