diff --git a/README.md b/README.md index 73012ccc..587e5646 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ -# filemanager +# File Browser Front-end -TODO +[![CircleCI](https://img.shields.io/circleci/project/github/filebrowser/frontend.svg?style=flat-square)](https://circleci.com/gh/filebrowser/frontend) +[![npm](https://img.shields.io/npm/v/filebrowser-frontend.svg)]() +[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) + +> This is an example file with default selections. + +## Install + +``` +npm install filebrowser-frontend +``` + +## Usage + +This package is not prepared to be used by other projects than [File Browser](https://github.com/filebrowser/filebrowser) itself. + +## Contribute + +Check the [community repository](https://github.com/filebrowser/community) for more information. + +## License + +[Apache 2.0](./LICENSE) File Browser Contributors