Skip to content

Commit 23e43f5

Browse files
author
Minggang Wang
committed
Update the README file
Fix #NONE
1 parent da25c38 commit 23e43f5

File tree

2 files changed

+25
-10
lines changed

2 files changed

+25
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ npm install
8989

9090
### Install from npmjs
9191

92-
Please run `npm i rclnodjs` to install the latest version OR `npm i rclnodjs@<version>` to install a specific version.
92+
Please run `npm i rclnodejs` to install the latest version **OR** `npm i rclnodejs@<version>` to install a specific version.
9393

9494
### Install from GitHub
9595

scripts/npmjs-readme.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# rclnodejs [![Build Status](https://travis-ci.org/RobotWebTools/rclnodejs.svg?branch=develop)](https://travis-ci.org/RobotWebTools/rclnodejs)
2+
13
`rclnodejs` is a Node.js client for Robot Operating System (ROS) v2.0. It provides extremely simple & easy API for ROS 2.0 programming, the following example shows how to create a ROS 2.0 node and then publish a string message in only 6 lines of code.
24

35
``` JavaScript
@@ -10,17 +12,32 @@ rclnodejs.init().then(() => {
1012
});
1113
```
1214

13-
# Install ROS 2.0
14-
Befire install rclnodejs, make sure ROS 2.0 is installed first. Read and follow the [Installation Guide](https://github.com/ros2/ros2/wiki/Installation) to install ROS 2.0
15+
## Install ROS 2.0
16+
17+
Before install rclnodejs, make sure ROS 2.0 is installed first. Read and follow the [Installation Guide](https://index.ros.org/doc/ros2/Installation/) to install ROS 2.0
18+
19+
## Install rclnodejs
1520

16-
# Install rclnodejs
1721
After ROS 2.0 is installed, run the following command
1822

19-
```
23+
``` bash
2024
npm i --save rclnodejs
2125
```
2226

23-
# More Examples
27+
## Match with ROS 2.0 Stable Releases
28+
29+
The latest release of rclnodejs is always verified with the [master](https://github.com/ros2/ros2) branch of ROS 2.0, but usually we will publish a new version after each ROS 2.0 release. Please find the specific version if you want to build your apps on one of ROS 2.0.
30+
31+
ROS 2.0 Release | rclnodejs Version |
32+
:------------: | :-------------: |
33+
[Bouncy Bolson](https://github.com/ros2/ros2/releases/tag/release-bouncy) | [0.3.5](https://www.npmjs.com/package/rclnodejs/v/0.3.5)
34+
[Crystal Clemmys](https://github.com/ros2/ros2/releases/tag/release-crystal-20181214) | [0.8.0](https://www.npmjs.com/package/rclnodejs/v/0.8.0)
35+
36+
## Document
37+
38+
Please browse our online [doucment](http://robotwebtools.org/rclnodejs/docs/index.html) to learn the detailed usage if you needed.
39+
40+
## More Examples
2441

2542
Use complex message
2643

@@ -59,8 +76,6 @@ rclnodejs.init().then(() => {
5976
});
6077
```
6178

62-
63-
6479
Create a service
6580

6681
```JavaScript
@@ -90,6 +105,6 @@ Send a request in a client
90105

91106
```
92107

93-
# License
94-
Apache License Version 2.0
108+
## License
95109

110+
Apache License Version 2.0

0 commit comments

Comments
 (0)