Skip to content

Commit

Permalink
Rebranded as @zenfs/cloud
Browse files Browse the repository at this point in the history
  • Loading branch information
james-pre committed Oct 27, 2024
1 parent 3d20ed5 commit 6690895
Show file tree
Hide file tree
Showing 5 changed files with 389 additions and 369 deletions.
34 changes: 25 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 10 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@zenfs/dropbox",
"version": "0.0.1",
"description": "ZenFS Dropbox backend",
"name": "@zenfs/cloud",
"version": "0.0.0",
"description": "ZenFS Cloud backends",
"funding": {
"type": "individual",
"url": "https://github.com/sponsors/james-pre"
Expand All @@ -10,21 +10,22 @@
"types": "src/index.ts",
"keywords": [
"filesystem",
"dropbox"
"dropbox",
"S3"
],
"type": "module",
"homepage": "https://github.com/zen-fs/dropbox",
"homepage": "https://github.com/zen-fs/cloud",
"author": "James Prevett <[email protected]> (https://jamespre.dev)",
"contributors": [
"John Vilk <[email protected]> (http://people.cs.umass.edu/~jvilk)"
],
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/zen-fs/dropbox.git"
"url": "git+https://github.com/zen-fs/cloud.git"
},
"bugs": {
"url": "https://github.com/zen-fs/dropbox/issues"
"url": "https://github.com/zen-fs/cloud/issues"
},
"engines": {
"node": ">= 18"
Expand All @@ -44,7 +45,7 @@
"format:check": "prettier --check .",
"lint": "eslint src",
"build": "tsc -p tsconfig.json",
"build:docs": "typedoc --out docs --name 'ZenFS Dropbox' src/index.ts",
"build:docs": "typedoc --out docs --name 'ZenFS Cloud' src/index.ts",
"test": "#tsx --test --experimental-test-coverage",
"prepublishOnly": "npm run build"
},
Expand All @@ -62,7 +63,7 @@
"peerDependencies": {
"@zenfs/core": "^1.0.4"
},
"dependencies": {
"optionalDependencies": {
"dropbox": "^10.34.0"
}
}
10 changes: 6 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# ZenFS Dropbox
# ZenFS Cloud

> [!WARNING]
> This package was implemented very recently and may not be stable.
>
> If you find a bug, please report it. Thanks!
This package adds the `Dropbox` backend for ZenFS.
This package adds backends for many cloud providers to ZenFS, including Dropbox, S3, and in the future, Google Drive.

For more information, see the [API documentation](https://zenfs.dev/dropbox).
For more information, see the [API documentation](https://zenfs.dev/cloud).

> [!IMPORTANT]
> Please read the [ZenFS core documentation](https://zenfs.dev/core)!
## Installing

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

## Usage
Expand All @@ -25,6 +25,8 @@ npm install @zenfs/dropbox
> 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)
#### Dropbox

```ts
import { configure, fs } from '@zenfs/core';
import { Dropbox } from '@zenfs/dropbox';
Expand Down
Loading

0 comments on commit 6690895

Please sign in to comment.