Trivial update for publishing (#70)

* Update README * Add change log
TCDSolar · Jun 2, 2024 · 0d737e5 · 0d737e5
1 parent d195e70
commit 0d737e5
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -28,19 +28,28 @@ Installation
 
 It is strongly advised that you use and isolated environment through python's venv, virturalenv, anaconda or similar.
 
+
+**The name 'xrayvision' was already taken on PyPi so the package name is 'xrayvisim' e.g.**
+
 .. code-block::
 
-    pip install xrayvision
+    pip install xrayvisim
 
 Usage
 -----
 
+See the `example gallery`_.
+
 Getting Help
 ------------
 
+See the `issue tracker`_.
+
 Contributing
 ------------
 When you are interacting with the community you are asked to
 follow the `Code of Conduct`_.
 
 .. _Code of Conduct: http://docs.sunpy.org/en/stable/coc.html
+.. _example gallery: https://xrayvision.readthedocs.io/en/latest/generated/gallery/index.html
+.. _issue tracker: https://github.com/TCDSolar/xrayvision/issues
diff --git a/changelog/67.feature.rst → changelog/67.breaking.rst b/changelog/67.feature.rst → changelog/67.breaking.rst
diff --git a/changelog/70.trivial.rst b/changelog/70.trivial.rst
@@ -0,0 +1 @@
+Update README with useful links to example and issue tracker.
diff --git a/setup.cfg b/setup.cfg
@@ -4,7 +4,7 @@ author = Shane Maloney
 author_email = shane.maloney@dias.ie
 license = BSD 3-Clause
 license_files = LICENSE.rst
-url = https://xrayvision.readthedocs.io/en/latest/
+url = https://github.com/TCDSolar/xrayvision
 description = An open-source Python library for Fourier or synthesis X-Ray imaging instruments.
 long_description = file: README.rst
 long_description_content_type = text/x-rst