Skip to content

updates to readme - #1

Open
aljazdb wants to merge 4 commits into
mainfrom
feat/readme-review
Open

updates to readme#1
aljazdb wants to merge 4 commits into
mainfrom
feat/readme-review

Conversation

@aljazdb

@aljazdb aljazdb commented May 11, 2026

Copy link
Copy Markdown
Collaborator

Additionally:

  • “All the examples can be found in the [examples](https://file+.vscode-resource.vscode-cdn.net/Users/aljazdraskovic-bracun/netis/taxud/ioss-rtu-go-sdk/internal/examples) folder”
    • tu bi blo dobro se vse example zlistat in kaj je njihov namen (npr. input / output)
    • Pri example v main.go funkcijah, na zacetku napisat kaj ta funkcija naredi
  • “See the CONTRIBUTION section for more details on SchemaPayload and how to add a new version” - kje je ta section?
  • “… and keys to its rightful…” - what keys?
  • “Signers” opisat kaj bo predstavljeno tukaj, zakaj vec signerjev, kaj delajo signerji…
    • SignV1 is a rtu.Signer function,” kaj je rtu.Signer?
    • Sign is a helper function, “ zakaj se uporablja?

@aljazdb
aljazdb requested a review from zigaNetis May 11, 2026 09:06
@gale8

gale8 commented May 22, 2026

Copy link
Copy Markdown
Collaborator

I have a couple notes regarding the structure and content of the README document:

  • In the CPK section: since an example was added showing how to derive a CPK from an *ecdsa.PublicKey, it could also be useful to include a short example of using the Parse method mentioned above, to demonstrate the reverse flow (CPKPublicKey)
  • In the SignedObject Limits section: it is not entirely clear what finalSize limit refers to - or is this a typo and should be final size limit? Right now I understood it like finalSize is some kind of new parameter.
  • A couple of "nitpicky" questions about the STRUCTURE consistency of the doc:
    • The use of word Usage: before code examples is not fully consistent:
      • it is used before code example in the Sign section,
      • but not in SignV1, External Signer, or Verify sections.
      • Suggestion: either remove it everywhere or apply it consistently across all example sections.
    • In the External Signer section's code example, comments are written inline (to the right of the code), whereas in the other code examples comments are placed above the relevant code lines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants