Skip to content

Commit f37cc2a

Browse files
committed
readme: update the README and CONTRIBUTING files
- Fixed some URLs. - Added the PyPI version and Python version badges to the README file. Signed-off-by: Diego Escalona <diego.escalona@digi.com>
1 parent af4043b commit f37cc2a

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

CONTRIBUTING.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Reporting a bug
1313
---------------
1414

1515
The way to report bugs is to use the
16-
`GitHub issue tracker <http://github.com/digidotcom/python-xbee/issues>`_.
16+
`GitHub issue tracker <http://github.com/digidotcom/xbee-python/issues>`_.
1717
Before reporting a bug, please read the following points:
1818

1919
#. Make sure that what you are seeing is really a bug by checking the
2020
`documentation <https://xbplib.readthedocs.io/en/latest>`_ and consulting
2121
the `FAQs <https://xbplib.readthedocs.io/en/latest/faq.html>`_ section.
2222
#. If you still think you have found a bug, make sure someone has not already
2323
reported it. See the list of
24-
`known issues <http://github.com/digidotcom/python-xbee/issues>`_.
24+
`known issues <http://github.com/digidotcom/xbee-python/issues>`_.
2525
#. If it has not been reported yet, create a new issue. Make sure to add enough
2626
detail so that the bug can be reproduced.
2727

@@ -38,14 +38,14 @@ Suggesting a new feature
3838
section to ensure that the behavior you would like the library to have is
3939
not excluded.
4040
#. Make sure someone has not already requested it. See the list of
41-
`known issues <http://github.com/digidotcom/python-xbee/issues>`_.
41+
`known issues <http://github.com/digidotcom/xbee-python/issues>`_.
4242
#. Submit your request in the issue tracker.
4343

4444

4545
Contributing code
4646
-----------------
4747

48-
#. Fork the `XBee Python library <http://github.com/digidotcom/python-xbee>`_
48+
#. Fork the `XBee Python library <http://github.com/digidotcom/xbee-python>`_
4949
repository (`how to fork a repo
5050
<https://help.github.com/articles/fork-a-repo/>`_).
5151
#. Create a branch for your contribution. Use a name that defines the purpose

README.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Digi XBee Python library
2-
========================
1+
Digi XBee Python library |pypiversion| |pythonversion|
2+
======================================================
33

44
This project contains the source code of the XBee Python library, an
55
easy-to-use API developed in Python that allows you to interact with Digi
@@ -42,16 +42,21 @@ How to contribute
4242
-----------------
4343

4444
The contributing guidelines are in the `CONTRIBUTING.rst document
45-
<https://github.com/digidotcom/python-xbee/blob/master/CONTRIBUTING.rst>`_.
45+
<https://github.com/digidotcom/xbee-python/blob/master/CONTRIBUTING.rst>`_.
4646

4747

4848
License
4949
-------
5050

51-
Copyright 2017, Digi International Inc.
51+
Copyright 2017-2019, Digi International Inc.
5252

53-
The `MPL 2.0 license <https://github.com/digidotcom/python-xbee/blob/master/LICENSE.txt>`_
53+
The `MPL 2.0 license <https://github.com/digidotcom/xbee-python/blob/master/LICENSE.txt>`_
5454
covers the majority of this project with the following exceptions:
5555

56-
* The `ISC license <https://github.com/digidotcom/python-xbee/blob/master/examples/LICENSE.txt>`_
56+
* The `ISC license <https://github.com/digidotcom/xbee-python/blob/master/examples/LICENSE.txt>`_
5757
covers the contents of the examples directory.
58+
59+
.. |pypiversion| image:: https://badge.fury.io/py/digi-xbee.svg
60+
:target: https://pypi.org/project/digi-xbee/
61+
.. |pythonversion| image:: https://img.shields.io/pypi/pyversions/digi-xbee.svg
62+
:alt: PyPI - Python Version

0 commit comments

Comments
 (0)