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

refactor: align with latest version of WoT README template #550

Merged
merged 3 commits into from
May 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
<p align="center">
<a href="https://w3.org/wot">
<img alt="Web of Things Homepage" src="https://www.w3.org/WoT/IG/wiki/images/8/8f/WOT-hz.svg" width="300" />
</a>
</p>

<p align="center">
<a href="https://w3c.social/@wot">
<img alt="Follow on Mastodon" src="https://img.shields.io/mastodon/follow/111609289932468076?domain=https%3A%2F%2Fw3c.social"></a>
<a href="https://twitter.com/W3C_WoT">
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/W3C_WoT"></a>
<a href="https://stackoverflow.com/questions/tagged/web-of-things">
<img alt="Stack Exchange questions" src="https://img.shields.io/stackexchange/stackoverflow/t/web-of-things?style=plastic"></a>
</p>

<p align="center">
<a href="https://www.w3.org/TR/wot-scripting-api/"> <!-- NOTE LINK -->
<img alt="Latest Note" src="https://img.shields.io/badge/W3C_Note-Latest-005a9c"></a>
<a href="https://w3c.github.io/wot-scripting-api/"> <!-- ED LINK -->
<img alt="Latest Editor's Draft" src="https://img.shields.io/badge/Editor's_Draft-Latest-fe914a"></a>
</p>

# Web of Things (WoT) Scripting API
[![Follow on Twitter](https://img.shields.io/twitter/follow/W3C_WoT.svg?label=follow+W3C_WoT)](https://twitter.com/W3C_WoT)
[![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/web-of-things?style=plastic)]( https://stackoverflow.com/questions/tagged/web-of-things)

General information about the Web of Things can be found on https://www.w3.org/WoT/.

Expand All @@ -16,15 +36,24 @@ To make contributions, please refer to [https://github.com/w3c/wotwg#contributin

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).

## Logistics

- Call information: We use the W3C Calendar. You can find the next Scripting API call at https://www.w3.org/groups/wg/wot/calendar.
- Wiki (contains agenda): https://www.w3.org/WoT/IG/wiki/WG_WoT_Scripting_API_WebConf
- [Contribution rules](./CONTRIBUTING.md)

## Publications

- [Latest Editor's Draft](https://w3c.github.io/wot-scripting-api/)
- [Latest Group Note](https://www.w3.org/TR/wot-scripting-api/)

---

## TypeScript Definitions

The specification uses WebIDL definitions, but [TypeScript definitions](./typescript) are also available.
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).

## Task Force Meeting Logistics

See https://www.w3.org/WoT/IG/wiki/WG_WoT_Scripting_API_WebConf.

## Technical Matrix

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