Skip to content

Commit

Permalink
Make clear this plugin does not work with arc 10, add peer dependency…
Browse files Browse the repository at this point in the history
… to try to denote this
  • Loading branch information
filmaj committed Mar 2, 2022
1 parent 3c53393 commit 3c52f01
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ repos, which are based on [Leonid Shevtov's deep dive into enabling direct-from-
S3 uploads using browser-based POST requests to
S3](https://leonid.shevtsov.me/post/demystifying-s3-browser-upload/).

## Requirements

⚠️ At this time this plugin only works with Architect 8.6.0 up to 9.x; Architect 10 is **not** supported.

## Installation

1. Install this plugin: `npm i arc-plugin-s3-image-bucket`
Expand Down Expand Up @@ -113,7 +117,7 @@ thumbnails under the `thumb/` directory of the S3 image bucket this plugin
creates.

The sample app also configures an HTTP proxy such that requests to `img/*` get
redirected to `thumb/*` on the S3 image bucket.
redirected to `thumb/*` on the S3 image bucket.

### Testing Locally

Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
"@architect/utils": "^2.0.5",
"s3rver": "3.6.1"
},
"peerDependencies": {
"@architect/architect": ">=8.6.0 <10"
},
"eslintConfig": {
"extends": "@architect/eslint-config",
"rules": {
Expand Down

0 comments on commit 3c52f01

Please sign in to comment.