diff --git a/README.md b/README.md index 75a90a7ad..e1bd2c99d 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,4 @@ See the READMEs of individual packages for more information. ## Packages - [roslibjs](./packages/roslib/README.md) +- [roslibjs examples](./packages/roslib-examples/README.md) diff --git a/package-lock.json b/package-lock.json index e27f8a555..a3f55a7ca 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,10 +1,9 @@ { - "name": "@robot-web-tools/workspace", + "name": "roslibjs", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@robot-web-tools/workspace", "workspaces": [ "packages/*" ] @@ -11103,6 +11102,10 @@ "resolved": "packages/roslib", "link": true }, + "node_modules/roslib-examples": { + "resolved": "packages/roslib-examples", + "link": true + }, "node_modules/run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", @@ -13438,7 +13441,6 @@ "eslint-plugin-jsdoc": "^61.1.12", "eslint-plugin-prettier": "^5.5.4", "globals": "^16.0.0", - "http-server": "^14.1.1", "jiti": "^2.6.1", "jsdom": "^27.0.0", "jspm": "^4.2.0", @@ -13455,6 +13457,16 @@ "engines": { "node": ">=20" } + }, + "packages/roslib-examples": { + "version": "2.0.0", + "license": "BSD-2-Clause", + "dependencies": { + "roslib": "^2.0.0" + }, + "devDependencies": { + "http-server": "^14.1.1" + } } } } diff --git a/package.json b/package.json index f5904a4bd..2783b7d18 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@robot-web-tools/workspace", + "//": "TODO: add a workspace name in the future once we have everything in a consistent namespace like @robot-web-tools/* on npm", "workspaces": [ "packages/*" ] diff --git a/packages/roslib-examples/README.md b/packages/roslib-examples/README.md new file mode 100644 index 000000000..d3f32359f --- /dev/null +++ b/packages/roslib-examples/README.md @@ -0,0 +1,5 @@ +# roslib-examples + +## Running the examples + +Run `npm start` to view the examples in your browser. diff --git a/packages/roslib-examples/package.json b/packages/roslib-examples/package.json new file mode 100644 index 000000000..45a0aaa87 --- /dev/null +++ b/packages/roslib-examples/package.json @@ -0,0 +1,38 @@ +{ + "name": "roslib-examples", + "version": "2.0.0", + "description": "Example usage of roslibjs", + "keywords": [ + "ROS", + "ros", + "roslib", + "roslibjs", + "robot" + ], + "homepage": "https://github.com/RobotWebTools/roslibjs#readme", + "bugs": { + "url": "https://github.com/RobotWebTools/roslibjs/issues" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/RobotWebTools/roslibjs.git" + }, + "license": "BSD-2-Clause", + "author": "Robot Webtools Team (https://robotwebtools.github.io)", + "contributors": [ + { + "name": "Ezra Brooks", + "email": "ezra@brooks.cx", + "url": "https://github.com/EzraBrooks" + } + ], + "scripts": { + "start": "http-server .. -o /roslib-examples/src/index.html" + }, + "devDependencies": { + "http-server": "^14.1.1" + }, + "dependencies": { + "roslib": "^2.0.0" + } +} diff --git a/packages/roslib/examples/action_client.html b/packages/roslib-examples/src/action_client.html similarity index 98% rename from packages/roslib/examples/action_client.html rename to packages/roslib-examples/src/action_client.html index b1fb732cf..d7659695f 100644 --- a/packages/roslib/examples/action_client.html +++ b/packages/roslib-examples/src/action_client.html @@ -2,7 +2,7 @@ - + + + + + + + + +