Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme updated: daemon run instructions added, obsolete info removed #67

Merged
merged 4 commits into from
Dec 11, 2024

Conversation

milyin
Copy link
Contributor

@milyin milyin commented Dec 11, 2024

  • added instruction how to run daemon with plugin
  • removed github npm repositiory instruction

Copy link

PR missing one of the required labels: {'dependencies', 'breaking-change', 'internal', 'bug', 'documentation', 'new feature', 'enhancement'}

@milyin milyin added the documentation Improvements or additions to documentation label Dec 11, 2024
README.md Outdated
```
- Run the zenoh router with:
`zenohd -c zenoh.json5`
Expected output is like:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Expected output is like:
Expected output should be something similar to

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

README.md Outdated
Comment on lines 119 to 121
2. Navigate to the directory `zenoh-ts`

1. Run the commands:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Navigate to the directory `zenoh-ts`
1. Run the commands:
1. Navigate to the directory `zenoh-ts`
2. Run the commands:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed - it all shoud be 1. 1. 1. - md does numbering automatically

README.md Outdated
Comment on lines 133 to 137
1. Install [deno](https://deno.com/)
1. Navigate to the `zenoh-ts/examples/deno` directory
1. Install the `zenoh-ts` library by running `yarn install`
1. Run zenohd with the remote_api plugin, configured to websocket port 10000, as described above
1. Run the examples by running `yarn example <PATH TO EXAMPLE>`, i.e. `yarn example src/z_sub.ts`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Install [deno](https://deno.com/)
1. Navigate to the `zenoh-ts/examples/deno` directory
1. Install the `zenoh-ts` library by running `yarn install`
1. Run zenohd with the remote_api plugin, configured to websocket port 10000, as described above
1. Run the examples by running `yarn example <PATH TO EXAMPLE>`, i.e. `yarn example src/z_sub.ts`
1. Install [deno](https://deno.com/)
2. Navigate to the `zenoh-ts/examples/deno` directory
3. Install the `zenoh-ts` library by running `yarn install`
4. Run zenohd with the remote_api plugin, configured to websocket port 10000, as described above
5. Run the examples by running `yarn example <PATH TO EXAMPLE>`, i.e. `yarn example src/z_sub.ts`

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing. Though yes, I agree that if user read this with e.g. vim, better to make correct numberring. Fixed

README.md Outdated
Comment on lines 142 to 146
yarn example src/pub.rs
```

```sh
yarn example src/sub.rs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
yarn example src/pub.rs
```
```sh
yarn example src/sub.rs
yarn example src/z_pub.ts
yarn example src/z_sub.ts

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we not also mention that the user can add configuration for certificates for secure websockets here ?

  secure_websocket: {
        certificate_path: 'path/to/certificate_path',
        private_key_path: 'path/to/private_key_path'
      }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The goal was to allow to user to run the examples immediately, without making any changes. The example with certificates is in "config.json5" file, I'll add reference to it to readme.
There is no way to comment out part of json config :-(

Copy link
Member

@Charles-Schleich Charles-Schleich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes after proof reading

@milyin milyin merged commit eefa882 into main Dec 11, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants