Update README and ignore it for testing

.github/workflows/run-tests.yml

@@ -4,9 +4,13 @@ name: Run tests
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
+    paths-ignore:
+      - '**/README.md'
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
 
 jobs:
   build:

README.md

@@ -6,18 +6,29 @@
 
 
 # pyebur128
-A Cython implementation of the libeur128 library for audio loudness in media files.
+A Cython implementation of the [libebur128](https://github.com/jiixyj/libebur128) library for audio loudness in media files.
+
+## Requirements
+
+* Operating Systems: Linux, macOS, or Windows
+* Python: 3.6+
+* Dependencies: None!
 
 ## Installation
 
-Working on getting wheels created/published, but for now you can easily run the following to get going:
+### PyPI
 
 ```
-python3 -m build
+pip install pyebur128
-pip install dist/pyebur128*.whl
+```
+
+### From Source
+
+```
+git clone --recurse-submodules https://github.com/jodhus/pyebur128
+cd pyebur128
+pip install .
 ```
 
 ## TODO
-1. Make a better README.md
+* Working on getting official documentation written/uploaded. In the meantime, all definitions are documented in within their docstrings.
-2. Create the docs and upload them
-3. Publish to PyPI