diff --git a/README.md b/README.md index 8d08d05f..5f9f5fa4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # InvenTree Mobile App +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +![CI](https://github.com/inventree/inventree-app/actions/workflows/lint.yaml/badge.svg) +![Android](https://github.com/inventree/inventree-app/actions/workflows/android.yaml/badge.svg) +![iOS](https://github.com/inventree/inventree-app/actions/workflows/ios.yaml/badge.svg) + The InvenTree mobile / tablet application is a companion app for the [InvenTree stock management system](https://github.com/inventree/InvenTree). Written in the [Flutter](https://flutter.dev/) environment, the app provides native support for Android and iOS devices. +## User Documentation + +User documentation for the InvenTree mobile app can be found [within the InvenTree documentation](https://inventree.readthedocs.io/en/latest/app/app/).