@@ -18,7 +18,9 @@ rclnodejs.init().then(() => {
1818 node .spin ();
1919});
2020```
21+
2122## Documentation
23+
2224- [ Installation] ( #installation )
2325- [ API Documentation] ( #api-documentation )
2426- [ Using TypeScript] ( #using-typescript )
@@ -30,18 +32,20 @@ rclnodejs.init().then(() => {
3032## Installation
3133
3234### Prerequisites
35+
3336Before installing ` rclnodejs ` please ensure the following softare is installed and configured on your systemd:
3437
3538- [ Nodejs] ( https://nodejs.org/en/ ) version between 8.12 - 12.x.
3639
3740- [ ROS 2 SDK] ( https://index.ros.org/doc/ros2/Installation/ ) for details.
38- ** DON'T FORGET TO [ SOURCE THE ROS 2 SETUP FILE] ( https://index.ros.org/doc/ros2/Tutorials/Configuring-ROS2-Environment/#source-the-setup-files ) **
41+ ** DON'T FORGET TO [ SOURCE THE ROS 2 SETUP FILE] ( https://index.ros.org/doc/ros2/Tutorials/Configuring-ROS2-Environment/#source-the-setup-files ) **
3942
4043### Installing rclnodejs
4144
4245Install the rclnodejs version that is compatible with your version of ROS 2 (see table below).
4346
4447For the most current version of rclnodejs run:
48+
4549``` bash
4650npm i rclnodejs
4751```
@@ -65,7 +69,7 @@ API documentation is generated by `jsdoc` and can be viewed in the `docs/` folde
6569
6670## Using TypeScript
6771
68- ` rclnodejs ` API can be used in TypeScript projects. You can find the TypeScript declaration files (\* .d.ts) in the ` types/ ` folder.
72+ ` rclnodejs ` API can be used in TypeScript projects. You can find the TypeScript declaration files (\* .d.ts) in the ` types/ ` folder.
6973
7074Your project ` tsconfig.json ` file should include the following compiler options:
7175
@@ -106,8 +110,39 @@ Please make sure to read the [Contributing Guide]() before making a pull request
106110
107111Thank you to all the [ people] ( CONTRIBUTORS.md ) who already contributed to rclnodejs!
108112
109- [ ![ ] ( https://github.com/minggangw.png?size=25 )] ( https://github.com/minggangw )
110- [ ![ ] ( https://github.com/wayneparrott.png?size=25 )] ( https://github.com/wayneparrott )
113+ <div >
114+ <a href =" https://github.com/wayneparrott " >
115+ <img src =" https://github.com/wayneparrott.png " width =" 30 " >
116+ </a >
117+ <a href =" https://github.com/koonpeng " >
118+ <img src =" https://github.com/koonpeng.png " width =" 30 " >
119+ </a >
120+ <a href =" https://github.com/mattrichard " >
121+ <img src =" https://github.com/mattrichard.png " width =" 30 " >
122+ </a >
123+ <a href =" https://github.com/felixdivo " >
124+ <img src =" https://github.com/felixdivo.png " width =" 30 " >
125+ </a >
126+ <a href =" https://github.com/martins-mozeiko " >
127+ <img src =" https://github.com/martins-mozeiko.png " width =" 30 " >
128+ </a >
129+ <a href =" https://github.com/amikhalev " >
130+ <img src =" https://github.com/amikhalev.png " width =" 30 " >
131+ </a >
132+ <a href =" https://github.com/kenny-y " >
133+ <img src =" https://github.com/kenny-y.png " width =" 30 " >
134+ </a >
135+ <a href =" https://github.com/qiuzhong " >
136+ <img src =" https://github.com/qiuzhong.png " width =" 30 " >
137+ </a >
138+ <a href =" https://github.com/minggangw " >
139+ <img src =" https://github.com/minggangw.png " width =" 30 " >
140+ </a >
141+ <a href =" https://github.com/hanyia " >
142+ <img src =" https://github.com/hanyia.png " width =" 30 " >
143+ </a >
144+ </div >
111145
112146## License
147+
113148This project abides by the [ Apache License 2.0] ( https://github.com/RobotWebTools/rclnodejs/blob/develop/LICENSE ) .
0 commit comments