Skip to content

Commit

Permalink
fix(dir methods): readme
Browse files Browse the repository at this point in the history
  • Loading branch information
korostelevm committed Jan 9, 2023
1 parent 5ea6b1b commit a55a0f7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,16 @@ Require in the same format as Node.js `fs`, specifying an S3 Bucket:

Authenticating the client:
- **Local Mode** - When no credentials are available - the client will fall back to using `fs` and the local filesystem with a warning.
- **cyclic.sh** - When deploying on <a href="https://cyclic.sh" target="_blank">cyclic.sh</a>, credentials are already available in the environment
- The bucket name is also available under the `CYCLIC_BUCKET_NAME` variable
- read more: <a href="https://docs.cyclic.sh/concepts/env_vars#cyclic" target="_blank">Cyclic Environment Variables</a>
- **Environment Variables** - the internal S3 client will use AWS credentials if set in the environment
```
AWS_REGION
AWS_ACCESS_KEY_ID
AWS_SECRET_KEY
AWS_SECRET_ACCESS_KEY
```
- **cyclic.sh** - When deploying on <a href="https://cyclic.sh" target="_blank">cyclic.sh</a>, credentials are already available in the environment
- The bucket name is also available under the `CYCLIC_BUCKET_NAME` variable
- read more: <a href="https://docs.cyclic.sh/concepts/env_vars#cyclic" target="_blank">Cyclic Environment Variables</a>
- **Client Credentials** - the library also accepts standard S3 client parameters at initialization:
```js
const fs = require('@cyclic.sh/s3fs')(S3_BUCKET_NAME, {
Expand Down

0 comments on commit a55a0f7

Please sign in to comment.