Document usage with cml publish (#1)

iterative · Sep 8, 2022 · 786d058 · 786d058
1 parent 1e4f8a6
commit 786d058
Showing 1 changed file with 11 additions and 1 deletion.
diff --git 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).