Skip to content

Commit

Permalink
Merge pull request w3c#1992 from w3c/egekorkan-patch-3
Browse files Browse the repository at this point in the history
Small Readme Improvements
  • Loading branch information
egekorkan authored Apr 3, 2024
2 parents 9a39b34 + 869db16 commit 284d447
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ This repository covers the W3C Web of Things Thing Description family of specifi

### Thing Description 1.1 (Maintenance)

- [Editor's Draft](http://w3c.github.io/wot-thing-description/) - Latest editor's draft of the Thing Description Maintenance version
- [Working Draft](https://www.w3.org/TR/wot-thing-description11/) - Latest working draft of the Thing Description Maintenance version
- [branch](https://github.com/w3c/wot-thing-description/tree/main) - Points to the main branch of this repository
- [REC](https://www.w3.org/TR/wot-thing-description11/) - Official recommendation version of the Thing Description 1.1
- [branch](https://github.com/w3c/wot-thing-description/tree/REC1.1) - Points to the 1.1 REC tagged branch of this repository
- [errata](https://w3c.github.io/wot-thing-description/errata11.html) - Errata for version 1.1 (empty at the moment)

### Thing Description 1.0

Expand Down Expand Up @@ -67,6 +67,10 @@ For Windows users, the script should be run in a [Cygwin shell](http://cygwin.co
The repository is equipped with git hooks that automate the rendering process. To enable them, run `npm install` in the root folder. The hooks will render the documents automatically at every commit.
If you run the rending process manually or you do not want to execute the automatic process add the `--no-verify` option to your commit command.

### Formatting

We use Prettier for automatically formatting the files such that we have small git diffs in Pull Requests. Make sure to run `npm run format` before committing your files. If not, a GitHub action will format them by overwriting your last commit.

## Implementation Report

To generate the implementation report,
Expand Down

0 comments on commit 284d447

Please sign in to comment.