Readme do-over (#10)

* Start readme do-over

* Update README.md

* Update README.md

* Update README.md

Author: roszcz

README.md

@@ -1,6 +1,44 @@
 # Fortepyan :musical_keyboard:
+
 ![GitHub CI](https://github.com/Nospoko/Fortepyan/actions/workflows/ci_tests.yaml/badge.svg?branch=master) [![Python 3.9](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads) [![PyPI version](https://img.shields.io/pypi/v/fortepyan.svg)](https://pypi.org/project/fortepyan/) [![PyPI download month](https://img.shields.io/pypi/dm/fortepyan.svg)](https://pypi.org/project/fortepyan/)
 
+**fortepyan** is a glorified pandas wrapper for midi files with piano music.
+
+The main class to operate with is `MidiPiece`, which gives you access to the notes dataframe, and some useful utilities:
+
+```python
+from fortepyan import MidiPiece
+
+piece = MidiPiece.from_file("foo.mid")
+
+piece.df
+#        pitch  velocity        start          end  duration
+# 0         52        70     0.000000     0.538542  0.538542
+# 1         52        62     0.660417     0.951562  0.291146
+# 2         57        62    20.769792    21.207812  0.438021
+# 3         67        65    62.172917    62.510937  0.338021
+# 4         69        56    62.179167    62.232292  0.053125
+```
+
+Using with HuggingFace datasets:
+
+
+```python
+from datasets import load_datasets
+
+dataset = load_dataset("epr-labs/maestro-sustain-v2", split="train")
+piece = MidiPiece.from_huggingface(dataset[312])
+piece.source
+# {
+#     'composer': 'Franz Liszt',
+#     'title': 'Dante Sonata',
+#     'split': 'train',
+#     'year': 2009,
+#     'midi_filename': '2009/MIDI-Unprocessed_11_R1_2009_06-09_ORIG_MID--AUDIO_11_R1_2009_11_R1_2009_09_WAV.midi',
+#     'dataset': 'maestro'
+# }
+```
+
 ### Usage
 
 ```python
@@ -12,6 +50,8 @@ ff.view.draw_pianoroll_with_velocities(piece)
 ff.view.make_piano_roll_video(piece, "tmp.mp4")
 ```
 
+## Contributing
+
 ### Development
 
 Pre-commit hooks with forced python formatting ([black](https://github.com/psf/black), [flake8](https://flake8.pycqa.org/en/latest/), and [isort](https://pycqa.github.io/isort/)):

pyproject.toml

@@ -38,6 +38,11 @@ dev = [
   "pytest-watch == 4.2.0",
   "streamlit-pianoroll == 0.7.1"
 ]
+test = [
+  "pytest ~= 8.0.0",
+  "pytest-watch == 4.2.0"
+]
+
 
 [project.urls]
 Homepage = "https://github.com/Nospoko/fortepyan"