Skip to content

Commit

Permalink
fix(doc): refresh docs, update protoc version
Browse files Browse the repository at this point in the history
Signed-off-by: dankeboy36 <dankeboy36@gmail.com>
  • Loading branch information
dankeboy36 committed Nov 17, 2024
1 parent 1264c8c commit d3b69b8
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 11 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ npm run test

### Notes

- The underlying `protoc` version is `3.20.3`. It comes from the [`protoc`](https://www.npmjs.com/package/protoc) dependency. `protoc` is not required on the `$PATH`
- The underlying `protoc` version is `3.19.1`. It comes from the [`@pingghost/protoc`](https://www.npmjs.com/package/@pingghost/protoc) dependency. `protoc` is not required on the `$PATH`

```sh
npx protoc --version
libprotoc 3.20.3
npx @pingghost/protoc --version
libprotoc 3.19.1
```

- Use [`debug`](https://www.npmjs.com/package/debug) to log additional details
Expand All @@ -120,16 +120,12 @@ npm run test

- Run the generator from the sources (or use the predefined `generate` VS Code task):
- `npm run compile`
- `node dist/cli.js generate 0.32.2 --out ./gen-output
- `node dist/cli.js generate 1.1.0 --out ./gen-output
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
### ⚠️ Disclaimer
The Arduino CLI, including the proto files, has a [GPL-3.0 license](https://github.com/arduino/arduino-cli/blob/master/LICENSE.txt). `ardunno-cli-gen` does not use any code from the CLI but relies on the proto files. There is an ongoing [conversation](https://github.com/arduino/arduino-cli/issues/1957) with Arduino to relicense the proto files with a more permissive license, such as MIT. Please [open a new issue](https://github.com/dankeboy36/ardunno-cli-gen/issues/new) if you have any concerns regarding the licensing of this project. Thank you!
I made `ardunno-cli-gen` with pure ❤️
## Acknowledgments
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ardunno-cli-gen",
"version": "0.1.8",
"version": "0.1.9",
"description": "Generates nice-grpc API for the Arduino CLI",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down

0 comments on commit d3b69b8

Please sign in to comment.