summaryrefslogtreecommitdiff
path: root/src/shipping/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/shipping/README.md')
-rw-r--r--src/shipping/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/shipping/README.md b/src/shipping/README.md
new file mode 100644
index 0000000..915a78a
--- /dev/null
+++ b/src/shipping/README.md
@@ -0,0 +1,23 @@
+# Shipping Service
+
+The Shipping service queries `quote` for price quote, provides tracking IDs,
+and the impression of order fulfillment & shipping processes.
+
+## Local
+
+This repo assumes you have rust 1.82 installed. You may use docker, or
+[install rust](https://www.rust-lang.org/tools/install).
+
+## Build
+
+From `../../`, run:
+
+```sh
+docker compose build shipping
+```
+
+## Test
+
+```sh
+cargo test
+```