Update README and package information.

Author: feilong

README.md

@@ -1,13 +1,21 @@
-This simple package contains a `brain_plot` function that plots data on cortical surface.
-It assumes that:
-- The data is in fsaverage space with icoorder3 resolution (642 vertices per hemisphere).
-- The non-cortical vertices has been masked out (588 and 587 remaining vertices for the left and right hemisphere, respectively).
+This is a Python package that plots data on cortical surface.
+
+## Installation
+The package can be installed with pip:
+```bash
+pip install brainplotlib
+```
+
+## Example usage
 
 ```Python
 import numpy as np
 from brainplotlib import brain_plot
 
-# Generate some random data
+## Generate some random data
+# In this case it's icoorder3 resolution (642 vertices per hemisphere), and
+# the non-cortical vertices have been masked out (588 and 587 remaining
+# vertices for the left and right hemisphere, respectively).
 rng = np.random.default_rng(0)
 v = rng.random((1175, ))
 

images/random_data.png

@@ -1,6 +1,6 @@
 [metadata]
 name = brainplotlib
-version = 0.1.0
+version = 0.2.0
 author = Ma Feilong
 author_email = mafeilong@gmail.com
 description = A lightweight package to plot brain surfaces with Python.
@@ -25,8 +25,12 @@ install_requires =
     matplotlib
 
 [options.package_data]
-    brainplotlib =
-        data/*.npy
+brainplotlib =
+    data/*.npy
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+tests =
+    pytest