From 786d058a3b3fd6a2ce8e7ea28aea52cea2a5dd12 Mon Sep 17 00:00:00 2001
From: Helio Machado <0x2b3bfa0+git@googlemail.com>
Date: Thu, 8 Sep 2022 21:20:57 +0200
Subject: [PATCH] Document usage with `cml publish` (#1)

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 901f7ae..84b992e 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # Minroud[^1]
-Simple [serverless](https://www.serverless.com) image hosting
+Simple [serverless](https://www.serverless.com) image hosting.
 
 ## Deployment
 
@@ -8,11 +8,21 @@ $ serverless deploy
 endpoint: https://{identifier}.lambda-url.{region}.on.aws
 ```
 
+See [this get started guide](https://www.serverless.com/framework/docs/getting-started) for more detailed instructions.
+
 ## Usage
 
+### With `curl`
 ```console
 $ curl {endpoint} --header "Content-Type: image/png" --data-binary @image.png
 https://{bucket}.s3.{region}.amazonaws.com/{hash}
 ```
 
+### With [`cml publish`](https://cml.dev/doc/ref/publish)
+
+```console
+$ cml publish --url={endpoint} image.png
+https://{bucket}.s3.{region}.amazonaws.com/{hash}
+```
+
 [^1]: Named after [Yor's Minroud](https://en.wikipedia.org/wiki/List_of_The_Neverending_Story_characters#Yor) from [The Neverending Story](https://en.wikipedia.org/wiki/The_Neverending_Story).