initial commit

README.md

@@ -0,0 +1,38 @@
+# PyQRangeSlider
+
+[![License](https://img.shields.io/pypi/l/PyQRangeSlider.svg?color=green)](https://github.com/tlambert03/PyQRangeSlider/raw/master/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/PyQRangeSlider.svg?color=green)](https://pypi.org/project/PyQRangeSlider)
+[![Python Version](https://img.shields.io/pypi/pyversions/PyQRangeSlider.svg?color=green)](https://python.org)
+[![tests](https://github.com/tlambert03/PyQRangeSlider/workflows/tests/badge.svg)](https://github.com/tlambert03/PyQRangeSlider/actions)
+[![codecov](https://codecov.io/gh/tlambert03/PyQRangeSlider/branch/master/graph/badge.svg)](https://codecov.io/gh/tlambert03/PyQRangeSlider)
+
+Multi-handle range slider widget for PyQt/PySide
+
+The goal of this package is to provide a QRangeSlider that feels as "native"
+as possible.  Styles should match the OS by default, and the slider should
+behave like a standard QSlider... just with multiple handles.
+
+- Attempts to match QSlider API as closely as possible
+- Uses platform-specific Qt styles
+- Supports style sheets
+- Supports mouse wheel and keypress (soon) events
+- Supports both PyQt5 and PySide2 (via qtpy)
+
+
+## Installation
+
+You can install `PyQRangeSlider` via [pip]:
+
+    pip install pyqrangeslider
+
+## License
+
+Distributed under the terms of the [BSD-3] license,
+"PyQRangeSlider" is free and open source software
+
+## Issues
+
+If you encounter any problems, please [file an issue] along with a detailed description.
+
+
+[file an issue]: https://github.com/tlambert03/PyQRangeSlider/issues