Merge pull request #1 from autamus/add/smuggler-logo

Adding more description to readme and smuggler logo
autamus · Jun 16, 2021 · 9721c03 · 9721c03
2 parents 0bff0a9 + 253b77d
commit 9721c03
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,8 @@
 # Smuggler
-Smuggler is a web server which can run within a GitHub workflow to allow you to upload files back to the host from something like a Docker build.
+
+![img/smuggler.png](img/smuggler.png)
+
+Smuggler is a web server that helps to get build artifacts out of containers. Specifically,
+if you run Smuggler as a service during a build in a Continuous Integration workflow, you
+can upload files back to the host (the CI worker) from your build. Smuggler is intended
+to be run as a GitHub Action, but can be extended to other use cases.
diff --git a/img/smuggler.png b/img/smuggler.png