Merge pull request #12 from quatrope/docEdit

Doc edit
quatrope · Dec 14, 2020 · e9f4d96 · e9f4d96
2 parents 0f786a1 + 385ff90
commit e9f4d96
Show file tree

Hide file tree

Showing 3 changed files with 170 additions and 165 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,7 @@ $ pip install -e .
 
 ```pycon
 >>> import pycf3
+>>> cf3 = pycf3.CF3()
 >>> result = cf3.calculate_distance(velocity=9000, glon=283, glat=75)
 >>> print(result.observed_velocity_)
 9000.0
@@ -69,7 +70,9 @@ documentation](https://pycf3.readthedocs.io).
 
 ## Citation
 
-Please acknowledge pycf3 in any research report or publication that
+- If you use the results of this work in your research or other applications, 
+please cite [Kourkchi et al. 2020, AJ, 159, 67](https://ui.adsabs.harvard.edu/abs/2020AJ....159...67K/abstract)
+- Please acknowledge pycf3 in any research report or publication that
 requires citation of any author\'s work. Our suggested acknowledgment
 is:
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -90,6 +90,7 @@ Quick Usage
 .. code-block:: pycon
 
    >>> import pycf3
+   >>> cf3 = pycf3.CF3()
    >>> result = cf3.calculate_distance(velocity=9000, glon=283, glat=75)
    >>> print(result.observed_velocity_)
    9000.0
@@ -102,9 +103,12 @@ documentation <https://pycf3.readthedocs.io>`_.
 Citation
 --------
 
-Please acknowledge pycf3 in any research report or publication that
-requires citation of any author\'s work. Our suggested acknowledgment
-is:
+
+* If you use the results of this work in your research or other applications, 
+  please cite `Kourkchi et al. 2020, AJ, 159, 67 <https://ui.adsabs.harvard.edu/abs/2020AJ....159...67K/abstract>`_
+* Please acknowledge pycf3 in any research report or publication that
+  requires citation of any author\'s work. Our suggested acknowledgment
+  is:
 
 ..