Merge pull request #318 from sbillinge/readme

chore: synchronize readme and index of docs

Author: sbillinge

README.rst

@@ -38,14 +38,16 @@
 diffpy.utils Package
 ========================================================================
 
-General purpose shared utilities for the diffpy libraries.
-
-The diffpy.utils package provides functions for extracting array data from
-variously formatted text files, an interpolation function based on the
-Whittaker-Shannon formula that can be used to resample a PDF or other profile
-function over a new grid, `DiffractionObject` for conveniently manipulating
-diffraction data, and some wx GUI utilities used by the PDFgui
-program.
+General utilities for analyzing diffraction data
+
+The diffpy.utils package provides a number of functions and classes designed to help
+researchers analyze their diffraction data.  It also includes some functionality for
+carrying out PDF analysis.  Examples are parsers for reading common format diffraction
+data files, ``DiffractionObjects`` that allow you to do algebra on diffraction patterns,
+tools for better capture and propagation of metadata,
+diffraction-friendly interpolation routines, as well as some other tools used across
+diffpy libraries.
+
 
 Citation
 --------

news/readme.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* no news needed: just a chore of no import
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

pyproject.toml

@@ -11,7 +11,7 @@ authors = [
 maintainers = [
   { name="Simon J.L. Billinge group", email="simon.billinge@gmail.com" },
 ]
-description = "Shared utilities for diffpy packages"
+description = "General utilities for analyzing diffraction data"
 keywords = ["text data parsers", "wx grid", "diffraction objects"]
 readme = "README.rst"
 requires-python = ">=3.11, <3.14"