Merge pull request #450 from openziti/readme_v0.4.15

README updates for v0.4.15 (#416)
2024-12-22 14:50:55 +01:00 · 2023-11-08 12:34:29 -05:00 · 2023-11-08 12:34:29 -05:00 · 6e16a856a7
commit 6e16a856a7
parent ec3b944862 82fa74bca5
31 changed files with 39 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -20,7 +20,37 @@ You can be up and sharing using the `zrok.io` service in minutes. Here is a syno

 ### And then... sharing...

-* `zrok share` to share resources immediately, simply and securely
+Easily share private network resources with public internet users, securely, without having to alter any of your local network configuration:
+
+```
+$ zrok share public localhost:8080
+```
+
+![zrok share public](docs/images/zrok_share_public.png)
+
+```
+$ curl -s https://dslno640nct4.share.zrok.io | head
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1"/>
+    <meta name="theme-color" content="#000000"/>
+    <meta name="description" content="zrok ui"/>
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+```
+
+Share "network drives" with public and private users running on Windows, macOS, or Linux systems:
+
+```
+$ zrok share public --backend-mode drive ~/Repos/zrok
+```
+
+![zrok share public -b drive](docs/images/zrok_share_public_drive.png)
+
+Mounting and working with shared drives is simple, and works with any applications on the end users' systems:
+
+![mounted zrok drive](docs/images/zrok_share_public_drive_explorer.png)

 See the [Concepts and Getting Started Guide](https://docs.zrok.io/docs/getting-started) for a full overview.

@ -70,6 +100,14 @@ The single `zrok` binary contains everything you need to operate `zrok` environm

 See the [Self-Hosting Guide](https://docs.zrok.io/docs/guides/self-hosting/self_hosting_guide/) for details on getting your own `zrok` service instance running.

+## zrok Office Hours
+
+We maintain a growing playlist of videos focusing on various aspects of `zrok`. This includes the "office hours" series, which are longer-format videos digging into the implementation of `zrok` and showcasing some of the latest features and capabilities:
+
+[![zrok Office Hours](https://img.youtube.com/vi/Edqv7yRmXb0/0.jpg)](https://www.youtube.com/watch?v=Edqv7yRmXb0&list=PLMUj_5fklasLuM6XiCNqwAFBuZD1t2lO2)
+
+
+
 ## Building

 If you are interested in building `zrok` for yourself instead of using a released package, please refer to [BUILD.md](./BUILD.md)
--- a/docs/images/zrok.png
+++ b/docs/images/zrok.png
--- a/docs/images/zrok_cover.png
+++ b/docs/images/zrok_cover.png
--- a/docs/images/zrok_deployment.drawio
+++ b/docs/images/zrok_deployment.drawio
--- a/docs/images/zrok_deployment.png
+++ b/docs/images/zrok_deployment.png
--- a/docs/images/zrok_docs_share.png
+++ b/docs/images/zrok_docs_share.png
--- a/docs/images/zrok_enable_modal.png
+++ b/docs/images/zrok_enable_modal.png
--- a/docs/images/zrok_frontends_v0.3.drawio
+++ b/docs/images/zrok_frontends_v0.3.drawio
--- a/docs/images/zrok_frontends_v0.3.png
+++ b/docs/images/zrok_frontends_v0.3.png
--- a/docs/images/zrok_not_found.png
+++ b/docs/images/zrok_not_found.png
--- a/docs/images/zrok_registration_success.png
+++ b/docs/images/zrok_registration_success.png
--- a/docs/images/zrok_reserved_not_found.png
+++ b/docs/images/zrok_reserved_not_found.png
--- a/docs/images/zrok_share_public.png
+++ b/docs/images/zrok_share_public.png
--- a/docs/images/zrok_share_public_drive.png
+++ b/docs/images/zrok_share_public_drive.png
--- a/docs/images/zrok_share_public_drive_explorer.png
+++ b/docs/images/zrok_share_public_drive_explorer.png
--- a/docs/images/zrok_share_reserved.png
+++ b/docs/images/zrok_share_reserved.png
--- a/docs/images/zrok_share_web_files.png
+++ b/docs/images/zrok_share_web_files.png
--- a/docs/images/zrok_share_web_website.png
+++ b/docs/images/zrok_share_web_website.png
--- a/docs/images/zrok_v0.1_overview.png
+++ b/docs/images/zrok_v0.1_overview.png
--- a/docs/images/zrok_verify.png
+++ b/docs/images/zrok_verify.png
--- a/docs/images/zrok_web_console.png
+++ b/docs/images/zrok_web_console.png
--- a/docs/images/zrok_web_console_empty.png
+++ b/docs/images/zrok_web_console_empty.png
--- a/docs/images/zrok_web_console_environment_spark.png
+++ b/docs/images/zrok_web_console_environment_spark.png
--- a/docs/images/zrok_web_console_explorer_share.png
+++ b/docs/images/zrok_web_console_explorer_share.png
--- a/docs/images/zrok_web_console_share_detail.png
+++ b/docs/images/zrok_web_console_share_detail.png
--- a/docs/images/zrok_web_console_share_frontend.png
+++ b/docs/images/zrok_web_console_share_frontend.png
--- a/docs/images/zrok_web_login.png
+++ b/docs/images/zrok_web_login.png
--- a/docs/images/zrok_web_ui_empty_environment_detail.png
+++ b/docs/images/zrok_web_ui_empty_environment_detail.png
--- a/docs/images/zrok_web_ui_empty_shares.png
+++ b/docs/images/zrok_web_ui_empty_shares.png
--- a/docs/images/zrok_web_ui_new_environment.png
+++ b/docs/images/zrok_web_ui_new_environment.png
--- a/docs/images/zrok_zoom_to_fit.png
+++ b/docs/images/zrok_zoom_to_fit.png