Update README.md

README.md

@@ -1,2 +1,67 @@
-# lightly-insights
-Easily get basic insights about your ML dataset
+# Lightly Insights
+
+![GitHub](https://img.shields.io/github/license/lightly-ai/labelformat)
+![Unit Tests](https://github.com/lightly-ai/lightly-insights/workflows/Tests/badge.svg)
+[![PyPI](https://img.shields.io/pypi/v/lightly-insights)](https://pypi.org/project/lightly-insights/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Get quick insights about your ML dataset.
+
+Lightly Insights visualises basic statistics of an image dataset. You provide a folder with images and object
+detection labels, and it generates a static HTML webpage with metrics and plots.
+
+#### Features
+
+- Supports all object detection label formats that can be read with [labelformat](https://github.com/lightly-ai/labelformat) package. That includes YOLO, COCO, KITTI, PascalVOC, Lightly and Labelbox.
+- Shows the image, object and class counts
+- Analyzes how many images have no labels, and provides their filenames.
+- Shows image samples
+- Shows an analysis of image and object sizes
+- Shows an analysis per class with object sizes, counts per image, location heatmap and other.
+- Typed
+- MIT licensed
+
+## Preview
+
+[TODO]
+
+## Screenshots
+
+![Lightly Insights Screenshot](screenshot0.png?raw=true "Lightly Insights Screenshot")
+![Lightly Insights Screenshot](screenshot1.png?raw=true "Lightly Insights Screenshot")
+![Lightly Insights Screenshot](screenshot2.png?raw=true "Lightly Insights Screenshot")
+
+## Usage
+
+[TODO]
+
+### Development
+
+The library targets python 3.7 and higher. We use poetry to manage the development environment.
+
+Here is an example development workflow:
+
+```bash
+# Create a virtual environment with development dependencies
+poetry env use python3.7
+poetry install
+
+# Make changes
+...
+
+# Autoformat the code
+poetry run make format
+
+# Run tests
+poetry run make all-checks
+```
+
+## Maintained By
+[Lightly](https://www.lightly.ai) is a spin-off from ETH Zurich that helps companies 
+build efficient active learning pipelines to select the most relevant data for their models.
+
+You can find out more about the company and it's services by following the links below:
+
+- [Homepage](https://www.lightly.ai)
+- [Web-App](https://app.lightly.ai)
+- [Lightly Solution Documentation (Lightly Worker & API)](https://docs.lightly.ai/)