beckn / beckn/protocol-specifications

Clean up Communication Section of the Readme

Open
#416 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
453
Forks
126
PR merge metrics
No merged PRs in 30d

Description

The [communication header of the readme](https://github.com/beckn/protocol-specifications#communication) could be cleaned up a little. I'm new to the protocol, so I was reading through to get a better idea of it.

At this point in the readme, there's a list of "types of communication" between a "BAP, BG, BPP" etc. These aren't familiar to me, and a quick search only brings me back here. Rather than using acronyms, these should be described, or maybe left to more specific documentation and linked to here.

Also, the last paragraph is essentially a repeat of the first. Both say the protocol is asynchronous, so this should be consolidated.

Overall very interesting project, I'm intrigued! I hope this feedback is well received.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.