Skip to content

Commit 11c6576

Browse files
committed
readme: update the README and CONTRIBUTING files
- Fixed some URL and md syntax issues. - Added the Bintray badge to the README file. Signed-off-by: Diego Escalona <diego.escalona@digi.com>
1 parent b7ce7c9 commit 11c6576

File tree

3 files changed

+30
-32
lines changed

3 files changed

+30
-32
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,43 @@
1-
How to Contribute
2-
=================
1+
# How to Contribute
2+
3+
## Getting help
34

4-
Getting help
5-
------------
65
To ask questions about the XBee Java Library go to the
76
[Digi Forum](http://www.digi.com/support/forum).
87

98

10-
Reporting a bug
11-
---------------
9+
## Reporting a bug
10+
1211
The way to report bugs is to use the
13-
[GitHub issue tracker](http://github.com/digidotcom/XBeeJavaLibrary/issues).
12+
[GitHub issue tracker](http://github.com/digidotcom/xbee-java/issues).
1413
Before reporting a bug, please read the following points:
1514

1615
1. Make sure that is really a bug by checking the
17-
[documentation](http://docs.digi.com/display/XBJLIB) and consulting the
18-
[FAQs](https://docs.digi.com/display/XBJLIB/Frequently+Asked+Questions+%28FAQs%29)
16+
[documentation](https://www.digi.com/resources/documentation/digidocs/90001438) and consulting the
17+
[FAQs](https://www.digi.com/resources/documentation/digidocs/90001438/#reference/r_xb_java_lib_faq.htm)
1918
section.
2019
2. If you still think you have found a bug, make sure someone has not already
2120
reported it. See the list of
22-
[known issues](http://github.com/digidotcom/XBeeJavaLibrary/issues).
21+
[known issues](http://github.com/digidotcom/xbee-java/issues).
2322
3. If it has not been reported yet, create a new issue. Make sure to add enough
2423
detail so that the bug can be reproduced.
2524

2625
**Note**: The issue tracker is for bugs, not requests for help. Questions
2726
should be asked on the [Digi Forum](http://www.digi.com/support/forum) instead.
2827

2928

30-
Suggesting a new feature
31-
------------------------
32-
1. Consult the [FAQs](https://docs.digi.com/display/XBJLIB/Frequently+Asked+Questions+%28FAQs%29)
29+
## Suggesting a new feature
30+
31+
1. Consult the [FAQs](https://www.digi.com/resources/documentation/digidocs/90001438/#reference/r_xb_java_lib_faq.htm)
3332
section to ensure that the behavior you would like is not excluded.
3433
2. Make sure someone has not already requested it. See the list of
35-
[known issues](http://github.com/digidotcom/XBeeJavaLibrary/issues).
34+
[known issues](http://github.com/digidotcom/xbee-java/issues).
3635
3. Submit your request in the issue tracker.
3736

3837

39-
Contributing code
40-
-----------------
41-
1. Fork the [XBee Java Library](http://github.com/digidotcom/XBeeJavaLibrary)
38+
## Contributing code
39+
40+
1. Fork the [XBee Java Library](http://github.com/digidotcom/xbee-java)
4241
repository ([how to fork a repo](https://help.github.com/articles/fork-a-repo/)).
4342
2. Create a branch for your contribution. Use a name that defines the purpose of the additions/modifications.
4443
3. Make your changes following the code style used in the library.

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
XBee Java Library
2-
=================
1+
# XBee Java Library [ ![Download](https://api.bintray.com/packages/digidotcom/maven/xbee-java/images/download.svg) ](https://bintray.com/digidotcom/maven/xbee-java/_latestVersion)
32

43
This project contains the source code of the XBee Java Library, an easy-to-use
54
API developed in Java that allows you to interact with Digi International's
@@ -43,21 +42,21 @@ Destination endpoint, Profile ID, and Cluster ID).
4342
different interfaces (Serial, Bluetooth Low Energy and MicroPython).
4443

4544

46-
Start Here
47-
----------
45+
## Start Here
46+
4847
The best place to get started is the
4948
[XBee Java Library documentation](http://www.digi.com/resources/documentation/digidocs/90001438/Default.htm).
5049

5150

52-
How to Contribute
53-
-----------------
51+
## How to Contribute
52+
5453
The contributing guidelines are in the
55-
[CONTRIBUTING.md](https://github.com/digidotcom/XBeeJavaLibrary/blob/master/CONTRIBUTING.md)
54+
[CONTRIBUTING.md](https://github.com/digidotcom/xbee-java/blob/master/CONTRIBUTING.md)
5655
document.
5756

5857

59-
License
60-
-------
58+
## License
59+
6160
Copyright 2017-2019, Digi International Inc.
6261

6362
This Source Code Form is subject to the terms of the Mozilla Public

pom.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<name>XBee Java Library Project</name>
1010
<inceptionYear>2014</inceptionYear>
1111
<description>Set of Java APIs to interact with Digi International's XBee radio frequency modules.</description>
12-
<url>https://github.com/digidotcom/XBeeJavaLibrary</url>
12+
<url>https://github.com/digidotcom/xbee-java</url>
1313

1414
<organization>
1515
<name>Digi International Inc.</name>
@@ -25,13 +25,13 @@
2525
</licenses>
2626

2727
<scm>
28-
<url>https://github.com/digidotcom/XBeeJavaLibrary/tree/master</url>
29-
<connection>scm:git:git://github.com/digidotcom/XBeeJavaLibrary.git</connection>
30-
<developerConnection>scm:git:ssh://github.com:digidotcom/XBeeJavaLibrary.git</developerConnection>
28+
<url>https://github.com/digidotcom/xbee-java/tree/master</url>
29+
<connection>scm:git:git://github.com/digidotcom/xbee-java.git</connection>
30+
<developerConnection>scm:git:ssh://github.com:digidotcom/xbee-java.git</developerConnection>
3131
</scm>
3232

3333
<issueManagement>
34-
<url>https://github.com/digidotcom/XBeeJavaLibrary/issues</url>
34+
<url>https://github.com/digidotcom/xbee-java/issues</url>
3535
<system>GitHub</system>
3636
</issueManagement>
3737

@@ -199,7 +199,7 @@
199199
<distributionManagement>
200200
<repository>
201201
<id>bintray-repo</id>
202-
<url>https://api.bintray.com/maven/digidotcom/maven/XBeeJavaLibrary</url>
202+
<url>https://api.bintray.com/maven/digidotcom/maven/xbee-java</url>
203203
</repository>
204204
</distributionManagement>
205205

0 commit comments

Comments
 (0)