@adonisjs/drive/README.md

A thin wrapper on top of Flydrive to work seamlessly with AdonisJS

# @adonisjs/drive

<br />

[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]

## Introduction

A thin wrapper on top of [Flydrive](https://flydrive.dev/) to work seamlessly with AdonisJS. The package comes pre-configured to serve files from the local filesystem using the AdonisJS HTTP server

## Official Documentation

The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/digging-deeper/drive)

## Contributing

One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.

We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.

## Code of Conduct

In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).

## License

AdonisJS Drive is open-sourced software licensed under the [MIT license](LICENSE.md).

[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/drive/checks.yml?style=for-the-badge
[gh-workflow-url]: https://github.com/adonisjs/drive/actions/workflows/checks.yml 'Github action'
[npm-image]: https://img.shields.io/npm/v/@adonisjs/drive/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/@adonisjs/drive/v/latest 'npm'
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adonisjs/drive?style=for-the-badge