updated setup and readme for initial release

spatialaudio · Jul 3, 2019 · fb06b00 · fb06b00
1 parent 4ca76a0
commit fb06b00
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 5 deletions.
diff --git a/NEWS.rst b/NEWS.rst
@@ -1,5 +1,5 @@
 Version History
 ===============
 
-Version 0.1.0 (YYY-MM-DD, pending):
+Version 0.1.0 (2019-07-03):
    Initial release.
diff --git a/README.rst b/README.rst
@@ -1,3 +1,18 @@
-python-sofa
-===========
-A python API for reading and writing SOFA files (https://www.sofaconventions.org/)
+Spatially Oriented Format for Acoustics (SOFA) API for Python
+=============================================================
+A Python API for reading, writing and creating SOFA files as defined by the SOFA conventions (version 1.0) found at https://www.sofaconventions.org/.
+
+Documentation:
+    https://python-sofa.readthedocs.io/
+
+Source code and issue tracker:
+    https://github.com/spatialaudio/python-sofa/
+
+License:
+    MIT -- see the file ``LICENSE`` for details.
+
+Quick start:
+    * Install Python 3
+    * ``python3 -m pip install python-sofa --user``
+    * Check out the examples in the documentation
+
diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@
         break
 
 setup(
-    name="sofa",
+    name="python-sofa",
     version=__version__,
     packages=find_packages('src'),
 	package_dir={'':'src'},