Skip to content

Commit

Permalink
Update READMEs again
Browse files Browse the repository at this point in the history
  • Loading branch information
adam-fowler committed Sep 20, 2024
1 parent 85ab773 commit c279be7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Examples converted to Hummingbird 2.0
- [multipart-form](https://github.com/hummingbird-project/hummingbird-examples/tree/main/multipart-form) - HTML form using Multipart form data, using MultipartKit
- [proxy-server](https://github.com/hummingbird-project/hummingbird-examples/tree/main/proxy-server) - Using AsyncHTTPClient to build a proxy server
- [response-body-processing](https://github.com/hummingbird-project/hummingbird-examples/tree/main/proxy-server) - Example showing how to process a response body in middleware.
- [s3-file-provider](https://github.com/hummingbird-project/hummingbird-examples/tree/main/s3-file-provider) - Use a custom FileProvider to serve files from S3 with FileMiddleware.
- [sessions](https://github.com/hummingbird-project/hummingbird-examples/tree/main/sessions) - Username/password and session authentication.
- [todos-dynamodb](https://github.com/hummingbird-project/hummingbird-examples/tree/main/todos-dynamodb) - Todos application, based off [TodoBackend](http://todobackend.com) spec, using DynamoDB.
- [todos-fluent](https://github.com/hummingbird-project/hummingbird-examples/tree/1.x.x/todos-fluent) - Todos application, based off [TodoBackend](http://todobackend.com) spec, using Fluent
Expand Down
6 changes: 5 additions & 1 deletion s3-file-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,8 @@ The example needs two environment variables:
- `s3_file_bucket`: The name of the bucket to serve files from

There is an optional environment variable:
- `s3_file_path`: Prefix to add when generating S3 file path.
- `s3_file_path`: Prefix to add when generating S3 file path.

When you run the app, as long as your AWS credentials allow it, you can go to a web browser and view the contents of your S3 bucket.

NB The S3 file provider does not recognise folders, so you will not get the automatic re-directing to `index.html` in folders.

0 comments on commit c279be7

Please sign in to comment.