Merge pull request #18 from roboflow/capjamesg-patch-1

README.md

@@ -1,21 +1,49 @@
-# Roboflow CLI
+![Roboflow banner](https://user-images.githubusercontent.com/60797147/240767170-1793a92b-4ef7-469e-ae43-2a188ea9d2d3.jpeg)
 
-Roboflow makes computer vision accessible to all developers.
-[https://roboflow.com](https://roboflow.com)
+# Roboflow CLI 💻
 
-**This project is under active development, use at your own risk**
+The Roboflow CLI provides a command line-driven method through which you can interface with Roboflow, upload data, and run inference on images.
 
-## CLI tool
+## Installation 🛠️
 
 This package install a `roboflow` CLI you can use from your terminal.
 
-To install this package and CLI globally:
+To install the Roboflow CLI, use the following command:
 
 ```
 npm i -g roboflow-cli
 ```
 
-### Authorize the CLI
+<details close>
+<summary>👉 Run the CLI in a docker container (alpha support)</summary>
+
+### Run the CLI in a docker container (alpha support)
+
+If you don't want to install node, npm and other roboflow cli dependencies, but still use the roboflow cli you can run it in a docker container.
+
+Assuming you have docker installed on your machine, first build the image
+
+```
+docker build -t roboflowcli:latest .
+```
+
+Then, run the Roboflow cli docker image:
+
+```
+# Authorize 
+
+docker run -it --rm -v ~/.config/roboflow:/root/.config/roboflow roboflowcli:latest auth
+
+# Use the CLI as usual inside a docker container.
+
+docker run -it --rm -v ~/.config/roboflow:/root/.config/roboflow roboflowcli:latest project list
+```
+
+Here we have mounted the roboflow credentials into the docker container. The first docker command authorizes the user and stores credentials 
+in the user's `$HOME/.config/roboflow` directory. These credentials are then mounted onto the docker container in subsequent runs, as shown above.
+</details>
+
+## Authenticate with the CLI
 
 To authorize your CLI, run the following command.
 
@@ -25,7 +53,7 @@ roboflow login
 
 This will open a browser window and have you log into roboflow where you can select any workspaces you want the CLI to store auth credentials for (The CLi will download the api keys for the workspaces and store them in a config fle in the `~/.config/roboflow` directory on your system).
 
-### Using the CLI
+## Quickstart 🚀
 
 You can use the `roboflow` CLI to:
 
@@ -53,31 +81,12 @@ or
 roboflow detect -h
 ```
 
-### Run the CLI in a docker container (alpha support)
-
-If you don't want to install node, npm and other roboflow cli dependencies, but still use the roboflow cli you can run it in a docker container.
-
-Assuming you have docker installed on your machine, first build the image
-
-```
-docker build -t roboflowcli:latest .
-```
-
-Then, run the roboflow cli docker image interactively like so
-
-
-
-```
-# Authorize 
-
-docker run -it --rm -v ~/.config/roboflow:/root/.config/roboflow roboflowcli:latest auth
+You will similarly have to mount any data directories in case you are uploading images or annotations, for example.
 
-# Use the CLI as usual inside a docker container.
+## Documentation 📚
 
-docker run -it --rm -v ~/.config/roboflow:/root/.config/roboflow roboflowcli:latest project list
-```
+To view a full reference for the RoboflowAPI and CLI, check out the [Roboflow API Reference](https://docs.roboflow.com/api-reference/install-cli).
 
-Here we have mounted the roboflow credentials into the docker container. The first docker command authorizes the user and stores credentials 
-in the user's `$HOME/.config/roboflow` directory. These credentials are then mounted onto the docker container in subsequent runs, as shown above.
+## License 🧑‍⚖
 
-You will similarly have to mount any data directories in case you are uploading images or annotations, for example.
+This project is licensed under an [MIT license](LICENSE).