Skip to content

Commit

Permalink
fix: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
korostelevm committed Jan 18, 2023
1 parent 45b5e10 commit 2468c17
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,15 @@ Require in the same format as Node.js `fs`, specifying an S3 Bucket:
const fs = require('@cyclic.sh/s3fs/promises')(S3_BUCKET_NAME)
```

> Alternatively, if the enviornment variable `CYCLIC_BUCKET_NAME` is set to an S3 bucket name, initialization can happen without specifying a bucket:
> ```js
> const fs = require('@cyclic.sh/s3fs')
> ```
> or
> ```js
> const fs = require('@cyclic.sh/s3fs/promises')
> ```
- On cyclic.sh
- Alternatively, when using with <a href="https://cyclic.sh" target="_blank">cyclic.sh</a> or if the environment variable `CYCLIC_BUCKET_NAME` is set to an S3 bucket name, initialization can happen without specifying a bucket:
```js
const fs = require('@cyclic.sh/s3fs')
```
or
```js
const fs = require('@cyclic.sh/s3fs/promises')
```

### Authentication

Expand Down

0 comments on commit 2468c17

Please sign in to comment.