From d178c541a315c97f7bb12c4894bf26fef395e7c2 Mon Sep 17 00:00:00 2001
From: Ali Mirlou <alimirlou@gmail.com>
Date: Sat, 15 Oct 2022 13:46:28 +0330
Subject: [PATCH] Update README.md

---
 README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 65 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1f2cb46..209450f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,65 @@
-# phoenix-binaries
-This repository is only to release and store Phoenix client binaries. You can find the latest CLI for your platform in "Releases" page.
+# Phoenix CLI
+Run your data science workloads on high-performance cloud infrastructure in the fewest of steps.
+
+# Table of contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contact](#contact)
+
+# Installation
+
+You can download and install the CLI for any of the following platforms.
+
+| Supported Platform | Download (Latest)            |
+| -------------------| -----------------------------|
+| Windows            | [Link][latest-windows-amd64] |
+| Linux              | [Link][latest-linux-amd64]   |
+| macOS              | [Link][latest-macos-amd64]   |
+
+[latest-windows-amd64]: https://github.com/RoboEpics/phoenix-binaries/releases/download/v0.1.0/phx-windows-amd64.exe
+[latest-linux-amd64]: https://github.com/RoboEpics/phoenix-binaries/releases/download/v0.1.0/phx-linux-amd64
+[latest-macos-amd64]: https://github.com/RoboEpics/phoenix-binaries/releases/download/v0.1.0/phx-darwin-amd64
+
+To download a specific version, visit the [releases page](https://github.com/RoboEpics/phoenix-binaries/releases).
+
+# Usage
+
+First you need to initialize Phoenix in your data science project directory:
+
+```bash
+phx init
+```
+
+This will create a `.phoenix` folder inside your project root directory.
+
+Next you need to login to the Phoenix Platform by running this command and filling out your credentials in the prompts:
+
+```bash
+phx login
+```
+
+As easily as that, now your project is ready for the cloud.
+
+## Running jobs
+
+You can run a job:
+
+```bash
+phx run --cluster $CLUSTER_NAME --flavor $FLAVOR_NAME --name $YOUR_JOB_NAME $COMMAND $ARGS
+```
+
+## Creating Jupyter Notebooks
+
+You can also run a Jupyter Notebook on-demand and attach it to Google Colab as an external powerful non-interrupting runtime kernel:
+
+```bash
+phx jupyter create --cluster $CLUSTER_NAME --flavor $FLAVOR_NAME --name $YOUR_JUPYTER_INSTANCE_NAME
+phx jupyter attach
+```
+
+Now, as long as your terminal is open, you can connect your Colab to this runtime using the "Connect to a local runtime" button in Colab interface.
+
+You can read more about how to connect Colab to a local runtime [here](https://research.google.com/colaboratory/local-runtimes.html).
+
+# Contact
+If you had any questions or problems, join our server on [**Discord**](https://discord.gg/8DMfjmn6gc).