Skip to content

Commit

Permalink
Added S3 caution message
Browse files Browse the repository at this point in the history
  • Loading branch information
james-pre committed Oct 27, 2024
1 parent 3f9024a commit 492f3da
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,16 @@ For more information, see the [API documentation](https://zenfs.dev/cloud).
> [!IMPORTANT]
> Please read the [ZenFS core documentation](https://zenfs.dev/core)!
## Installing
### Installing

```sh
npm install @zenfs/cloud
```

## Usage

> [!NOTE]
> The examples are written in ESM.
> For CJS, you can `require` the package.
> If using a browser environment, you can use a `<script>` with `type=module` (you may need to use import maps)
> Examples are written using ESM.
#### Dropbox
## Dropbox

```ts
import { configure, fs } from '@zenfs/core';
Expand All @@ -51,7 +47,10 @@ await configure({
});
```

#### S3
## S3

> [!CAUTION]
> This backend is still in the process of being developed and is not stable.
```ts
import { configure, fs } from '@zenfs/core';
Expand Down

0 comments on commit 492f3da

Please sign in to comment.