diff --git a/README.md b/README.md index 5ced188..fce8f62 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ # ShipmentNotifier -Script that sends a Discord message when a new shipment is detected in the Amazon SP-API. \ No newline at end of file +Script that polls the Amazon SP-API for most recent shipments, if a shipment is found that has been created in the last 10 minutes, sends a Discord notification to a provided webhook. + +- Acceptable time delta: < 10 minutes +- Number of shipments to look for: 10 +- Recommended to run every 10 minutes via cron \ No newline at end of file