diff --git a/README.rst b/README.rst index f27aca7..fe8ea75 100644 --- a/README.rst +++ b/README.rst @@ -5,18 +5,24 @@ Quickstart pip install invoke invoke requirements - invoke apify sample.xlsx sqlite:///$(pwd)/autoapi.sqlite - invoke serve sqlite:///$(pwd)/autoapi.sqlite + export AWS_ACCESS_KEY_ID="..." + export AWS_SECRET_ACCESS_KEY="..." + export AUTOAPI_BUCKET="..." + invoke serve curl http://localhost:5000 curl http://localhost:5000/sample curl http://localhost:5000/sample/1 curl http://localhost:5000/sample?LastName=SMITH - -## Example Implementation +Example Implementation +---------------------- * https://autoapi.18f.gov/ * if you want to see json, you can `curl https://autoapi.18f.gov` * https://autoapi.18f.gov/admin - `api-program` / `all-the-things` +AWS Integration +--------------- + +**autoapi** synchronizes with the S3 bucket specified in the `AUTOAPI_BUCKET` environment variable. On starting the API server, **autoapi** creates a subscription to the target bucket using Amazon SNS. When files are added to or deleted from the bucket, the corresponding endpoints will automatically be updated on the API.