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

Improve README #553

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve README #553

wants to merge 2 commits into from

Conversation

relu91
Copy link
Member

@relu91 relu91 commented May 15, 2024

As discussed in the last Scripting API call I improved the README to be more user-friendly and adhere more to the template.

Copy link
Member

@JKRhb JKRhb left a comment

Choose a reason for hiding this comment

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

Looks good to me :) See two comments below.

README.md Outdated Show resolved Hide resolved

Releases for [published versions](https://www.w3.org/TR/wot-scripting-api/) are found in [releases](./releases/).
This specification describes an application programming interface (API) representing the WoT Interface that allows scripts to discover, operate Things, and expose locally defined Things characterized by WoT Interactions specified by a script.
Copy link
Member

Choose a reason for hiding this comment

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

I feel like “script” is a bit doubled here, maybe we can also omit the second occurrence?

On the other hand, although it introduces some redundancy, I had the feeling that something is missing after “discover”:

Suggested change
This specification describes an application programming interface (API) representing the WoT Interface that allows scripts to discover, operate Things, and expose locally defined Things characterized by WoT Interactions specified by a script.
This specification describes an application programming interface (API) representing the WoT Interface that allows scripts to discover Things, operate Things, and expose locally defined Things characterized by WoT Interactions.

Co-authored-by: Jan Romann <jan.romann@hs-emden-leer.de>
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.

None yet

2 participants