<div id="top"></div>
<div align="center">
  <h3 align="center">npm install @cloudos/fs</h3>
  <p align="center">
    <b>Node-style file system API in browser.</b>
    <!-- <br/> -->
       <!-- <a href="README_CN.md">中文文档</a> -->
</p>
</div>

## About The Project

Node-style file system API in browser, using Local Storage, IndexedDB, Gitee repository, more backends can be extended.

### Built With

- typescript
- [browserfs](https://github.com/jvilk/BrowserFS)
- [lightning-fs](https://github.com/isomorphic-git/lightning-fs)
- [@cloudos/gitee-fs](https://gitee.com/peiiii/cloudos-gitee-fs)

## Getting Started

1. Install with `npm i @cloudos/fs` or `yarn add @cloudos/fs`.
2. Call the API just like in node;

```js
import { fs } from "@cloudos/fs";
fs.readdir("/", console.log);
```

### Use In Browser

```html
<script src="https://cdn.jsdelivr.net/npm/@cloudos/fs/dist/fs.iife.js"></script>
<script>
  var fs = FS.fs;
  fs.readdir("/", console.log);
</script>
```

## License

MIT License.

<p align="right">(<a href="#top">back to top</a>)</p>
