Merge pull request #46 from zenml-io/misc/update-readme-for-launch

Minor polishing of the readme for launch

Author: htahir1

README.md

@@ -32,7 +32,7 @@
     ·
     <a href="#-meet-the-team">Meet the Team</a>
     <br />
-    🎉 Version 0.0.1 is out. Check out the release notes
+    🎉 Version 0.1.0 is out. Check out the release notes
     <a href="https://github.com/zenml-io/zenml-dashboard/releases">here</a>.
     <br />
     <br />
@@ -45,6 +45,36 @@
   </p>
 </div>
 
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>🏁 Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#-getting-started">⚡ Getting Started</a>
+      <ul>
+        <li><a href="#-installation">🔋 Installation</a></li>
+        <li><a href="#-relationship-with-zenml">👨‍👦 Relationship with ZenML</a></li>
+        <li><a href="#-deploying-the-dashboard">🪐 Deploying the dashboard</a></li>
+      </ul>
+    </li>
+    <li>
+    <a href="#-user-experience">🏄 User Experience</a>
+    <ul>
+        <li><a href="#-log-in">🔐 Log In</a></li>
+        <li><a href="#-home-page">🏠 Home Page</a></li>
+        <li><a href="#-pipelines-stacks-and-components">🗂 Pipelines, Stacks, and Components</a></li>
+      </ul>
+    </li>
+    <li><a href="#-contributing">🙌 Contributing</a></li>
+    <li><a href="#-meet-the-team">👩‍👩‍👧‍👦 Meet the Team</a></li>
+    <li><a href="#-getting-help">🆘 Getting Help</a></li>
+    <li><a href="#-license">📜 License</a></li>
+  </ol>
+</details>
+
+<br />
+
+
 # ⚡ Getting Started
 
 ## 🔋 Installation
@@ -91,21 +121,23 @@ Which will serve the dashboard with the server at `http://localhost:8080`, with
 
 ## 👨‍👦 Relationship with ZenML
 
-The ZenML Dashboard is a Javascript React-based application that lives inside this repository, which is a sister repository of the main [ZenML Python package repo](https://github.com/zenml-io/zenml).
+The ZenML Dashboard is a Javascript React-based application that lives inside this repository, which is a sister repository of the main [ZenML Python package repo](https://github.com/zenml-io/zenml). 
+
+> **Note** - The ZenML Dashboard is meant to be used with the ZenML Server as a backend and cannot be used standalone.
 
 The dashboard build files come bundled into the [ZenML PyPi package](https://pypi.org/project/zenml/) and can be [served locally](https://docs.zenml.io/getting-started/deploying-zenml/using-cli.md) and/or [deployed on the cloud](https://docs.zenml.io/getting-started/deploying-zenml/deployment.md) through the main ZenML python package.
 
-Basically, each ZenML python package comes with the build files (generated by `yarn build`) of a certain version of this dashboard (all build files of the dashboard can be seen in the releases section of this github). Therefore, each ZenML pypi package has bundled in it a corresponding version of this dashboard.
+Basically, each ZenML `Python` package comes with the build files (generated by `yarn build`) of a certain version of this dashboard (all build files of the dashboard can be seen in the [releases](https://github.com/zenml-io/zenml-dashboard/releases) section of this GitHub repo). Therefore, each ZenML PyPi package has bundled in it a corresponding version of this dashboard.
 
-With the python package, you can then serve these static build files by doing:
+With the `Python` package, you can then serve these static build files by doing:
 
 ```
 zenml up
 ```
 
 ![img](./assets/zenml-up.gif)
 
-Which creates a local daemon that serves the files in a FastAPI server!
+Which creates a local daemon that serves the files in a [FastAPI](https://github.com/tiangolo/fastapi) server!
 
 ## 🪐 Deploying the dashboard
 
@@ -121,16 +153,16 @@ However, the option to deploy standalone is also available. `yarn build` creates
 
 Just don't forget to the set the `REACT_APP_BASE_API_URL` environment variable!
 
-# :bowtie: User Experience
+# 🏄 User Experience
 
-## Log In
+## 🔐 Log In
 
 ![img](./assets/screenshot-login.png)
 
-## Home Page
+## 🏠 Home Page
 ![img](./assets/screenshot-home.png)
 
-## Pipelines, Stacks and Components
+## 🗂 Pipelines, Stacks and Components
 ![img](./assets/dashboard.gif)
 
 
@@ -148,20 +180,12 @@ Guide](CONTRIBUTING.md) for all relevant details.
 
 ![Meet the Team](./assets/community_meetup.png)
 
-Have a question that's too hard to express on our Slack? Is it just too much effort to say everything on a 
-long GitHub issue? Or are you just curious about what ZenML has been up to in the past week? 
-
-Well, register now for the ZenML Meet the Community session to get your answers!
-It's free and open to everyone.
-
 Every week, the ZenML [core team](https://zenml.io/company#CompanyTeam) will pop in for 30 minutes to interact directly with the community. 
 Sometimes we'll be presenting a feature, other times we'll take questions and have fun. 
 
-Join us if you are curious about ZenML, or just want to talk shop about MLOps.
+[Register now](https://zenml.io/meet) for the ZenML Meet the Community session. It's free and open to everyone.
 
-We will host the gathering every Wednesday 8:30AM PT (5:30PM CET). 
-Register now through [this link](https://www.eventbrite.com/e/zenml-meet-the-community-tickets-354426688767), 
-or subscribe to the [public events calendar](https://calendar.google.com/calendar/u/0/r?cid=Y19iaDJ0Zm44ZzdodXBlbnBzaWplY3UwMmNjZ0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) to get notified 
+Or subscribe to our [public events calendar](https://calendar.google.com/calendar/u/0/r?cid=Y19iaDJ0Zm44ZzdodXBlbnBzaWplY3UwMmNjZ0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) to get notified 
 before every community gathering.
 
 # 🆘 Getting Help
@@ -173,7 +197,7 @@ By far the easiest and fastest way to get a response is to:
 
 # 📜 License
 
-`zenml-dashboard` is distributed under the terms of the Apache License Version 2.0. 
+ZenML Dashboard is distributed under the terms of the Apache License Version 2.0. 
 A complete version of the license is available in the [LICENSE](LICENSE) file in
 this repository. Any contribution made to this project will be licensed under
 the Apache License Version 2.0.