Skip to content

Commit 707f6d4

Browse files
authored
Add demo links to README of npm package (#1217)
This PR adds demo links to the npm package README to help users find example code and implementations. The changes provide better guidance for developers looking to use rclnodejs in different contexts. - Adds links to JavaScript examples after the basic usage section - Adds links to TypeScript demos in the TypeScript section - Introduces a new section for Electron usage with demo links Fix: #1216
1 parent 31df1dd commit 707f6d4

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

scripts/npmjs-readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ Send a request in a client
121121

122122
```
123123

124+
Check out more [examples](https://github.com/RobotWebTools/rclnodejs/tree/develop/example).
125+
124126
## Using rclnodejs with TypeScript
125127

126128
In your node project install the rclnodejs package as described above. You will also need the TypeScript compiler and node typings installed.
@@ -162,8 +164,14 @@ const msg: rclnodejs.std_msgs.msg.String = {
162164
};
163165
```
164166

167+
Check out more TypeScript [demos](https://github.com/RobotWebTools/rclnodejs/tree/develop/ts_demo).
168+
165169
**Note** that the interface.d.ts file is updated each time the generate_messages.js script is run.
166170

171+
## Using rclnodejs with Electron
172+
173+
Check out [demos](https://github.com/RobotWebTools/rclnodejs/tree/develop/electron_demo).
174+
167175
## License
168176

169177
Apache License Version 2.0

0 commit comments

Comments
 (0)