Updated docs and added pip install instructions

CHANGELOG.md

@@ -7,8 +7,8 @@ The format is based on [Keep a
 Changelog](https://keepachangelog.com/en/1.0.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-\[Unreleased\]
---------------
+\[0.1b\]
+--------
 
 ### Added
 

README.md

@@ -7,10 +7,17 @@ institutions. This package was developed in the Department of Mineral
 Sciences at the Smithsonian National Museum of Natural History to
 streamline the process of getting data into and out of EMu.
 
+In addition to the instructions below, a guide and API reference are
+available in the [documentation](https://xmu.readthedocs.io/en/latest/).
+
 Install
 -------
 
-Install from the GitHub repository using git and pip:
+Install xmu with pip:
+
+    pip install xmu
+
+Or install from the GitHub repository using git and pip:
 
     git clone https://github.com/adamancer/xmu
     cd xmu
@@ -51,11 +58,11 @@ for rec in reader:
       "EmuInteger": 100,
       "EmuFloat": 1.2,
       "EmuDate": "1970-01-01",             # dates are strings or datetime.date
-      "EmuRef": {"irn": 1234567}           # references are dicts
+      "EmuRef": {"irn": 1234567},          # references are dicts
       "EmuTable_tab": ["Row 1", "Row 2"],  # tables are lists
       "EmuRef_tab": [{"irn": 1234567}],    # ref tables are lists of dicts
-      "EmuNested_nesttab": [["Nested"]]    # nested tables are lists of lists
-      "EmuBadKey": ["Bad format"]          # bad keys or formats throw an error
+      "EmuNested_nesttab": [["Nested"]],   # nested tables are lists of lists
+      "EmuBadKey": ["Bad format"],         # bad keys or formats throw an error
     }, module=reader.module)
 
     # Create a list of records to import

docs/user-guide.md

@@ -4,7 +4,11 @@ User guide
 Install
 -------
 
-Install from the GitHub repository using git and pip:
+Install xmu with pip:
+
+    pip install xmu
+
+Or install from the GitHub repository using git and pip:
 
     git clone https://github.com/adamancer/xmu
     cd xmu
@@ -45,11 +49,11 @@ for rec in reader:
       "EmuInteger": 100,
       "EmuFloat": 1.2,
       "EmuDate": "1970-01-01",             # dates are strings or datetime.date
-      "EmuRef": {"irn": 1234567}           # references are dicts
+      "EmuRef": {"irn": 1234567},          # references are dicts
       "EmuTable_tab": ["Row 1", "Row 2"],  # tables are lists
       "EmuRef_tab": [{"irn": 1234567}],    # ref tables are lists of dicts
-      "EmuNested_nesttab": [["Nested"]]    # nested tables are lists of lists
-      "EmuBadKey": ["Bad format"]          # bad keys or formats throw an error
+      "EmuNested_nesttab": [["Nested"]],   # nested tables are lists of lists
+      "EmuBadKey": ["Bad format"],         # bad keys or formats throw an error
     }, module=reader.module)
 
     # Create a list of records to import

setup.py

@@ -5,9 +5,17 @@
 long_description = (
     "xmu is a Python utility used to read and write XML for Axiell EMu,"
     " a collections management system used in museums, galleries, and"
-    " similar institutions.\n\n"
+    " similar institutions."
+    "\n\n"
+    " Install with:"
+    "\n\n"
+    "```\n"
+    "pip install xmu\n"
+    "```"
+    "\n\n"
     "Learn more:\n\n"
-    "+ [GitHub repsository](https://github.com/adamancer/xmu)"
+    "+ [GitHub repsository](https://github.com/adamancer/xmu)\n"
+    "+ [Documentation](https://xmu.readthedocs.io/en/latest/)"
 )
 
 
@@ -21,6 +29,13 @@
     version="0.1b1",
     classifiers=[
         "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Topic :: Text Processing :: Markup :: XML",
     ],
     url="https://github.com/adamancer/xmu.git",
     license="MIT",