Skip to content

Commit 7c4146a

Browse files
authored
Improve README
1 parent 23dc59e commit 7c4146a

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,26 @@
2525
General information about the Web of Things can be found on https://www.w3.org/WoT/.
2626

2727
---
28+
The Web of Things (WoT) is made of entities (Things) that can describe their capabilities in a machine-interpretable Thing Description (TD) and expose these capabilities through the WoT Interface, that is, network interactions modeled as Properties (for reading and writing values), Actions (to execute remote procedures with or without return values) and Events (for signaling notifications).
2829

29-
The main deliverable being developed in this repository is the [WoT Scripting API Specification](http://w3c.github.io/wot-scripting-api/).
30+
Scripting API is an optional building block in WoT and it is typically used in gateways or browsers that can run a WoT Runtime and script management, providing a convenient way to use WoT concepts in high-level applications.
3031

31-
Releases for [published versions](https://www.w3.org/TR/wot-scripting-api/) are found in [releases](./releases/).
32+
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.
3233

33-
See the [rationale.md](./rationale.md) for explanation on API design choices.
34-
35-
To make contributions, please refer to [https://github.com/w3c/wotwg#contributing](https://github.com/w3c/wotwg#contributing).
36-
37-
If you want to make a full text review on the spec or other files, follow the steps outlined [here](https://github.com/w3c/wot-scripting-api/pull/248).
34+
See the [rationale.md](./rationale.md) for an explanation of API design choices.
3835

3936
## Logistics
4037

4138
- Call information: We use the W3C Calendar. You can find the next Scripting API call at https://www.w3.org/groups/wg/wot/calendar.
4239
- Wiki (contains agenda): https://www.w3.org/WoT/IG/wiki/WG_WoT_Scripting_API_WebConf
4340
- [Contribution rules](./CONTRIBUTING.md)
41+
- If you want to make a full-text review on the spec or other files, follow the steps outlined [here](https://github.com/w3c/wot-scripting-api/pull/248).
4442

4543
## Publications
4644

4745
- [Latest Editor's Draft](https://w3c.github.io/wot-scripting-api/)
4846
- [Latest Group Note](https://www.w3.org/TR/wot-scripting-api/)
47+
- Releases for other [published versions](https://www.w3.org/TR/wot-scripting-api/) are found in [releases](./releases/).
4948

5049
---
5150

@@ -54,7 +53,7 @@ If you want to make a full text review on the spec or other files, follow the st
5453
The specification uses WebIDL definitions, but [TypeScript definitions](./typescript) are also available.
5554
We use [json-schema-to-typescript](https://www.npmjs.com/package/json-schema-to-typescript) to generate the TypeScript definitions for [wot-thing-description-types](https://github.com/w3c/wot-scripting-api/tree/main/typescript/thing-description) and [wot-thing-models-types](https://github.com/w3c/wot-scripting-api/tree/main/typescript/thing-model).
5655

57-
## Technical Matrix
56+
## Labelling conventions
5857

5958
We use [labels](https://github.com/w3c/wot-scripting-api/labels) to categorize our work items.
6059

0 commit comments

Comments
 (0)