Skip to content

Commit ccb371b

Browse files
authored
Update README for 2.0
1 parent fe03611 commit ccb371b

File tree

1 file changed

+9
-29
lines changed

1 file changed

+9
-29
lines changed

README.md

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,19 @@ It is an open source [Web of Things](https://www.w3.org/WoT/) gateway.
1212

1313
## Installation
1414

15-
- If you have a Rasberry Pi, the easiest way to use the gateway is to [download and flash](http://webthings.io/gateway/) a pre-built software image to an SD card.
16-
- If you prefer to use Docker, we have a prebuilt Docker image available [here](https://hub.docker.com/r/webthingsio/gateway), for both ARM and amd64. You can also build your own image from this repository.
17-
- On Ubuntu or Ubuntu Core you can install the experimental [snap package](https://snapcraft.io/webthings-gateway).
18-
- Otherwise, you can build WebThings Gateway from source yourself (see below).
15+
As of the 2.0 release, the recommended way to install WebThings Gateway is using the [Docker image](https://hub.docker.com/r/webthingsio/gateway). There is also an experimental [snap package](https://snapcraft.io/webthings-gateway), or you can build from source yourself (see below).
1916

2017
## Documentation
2118

22-
- [Getting Started Guide](https://webthings.io/docs/gateway-getting-started-guide.html)
23-
- [User Guide](https://webthings.io/docs/gateway-user-guide.html)
19+
- [Documentation](https://webthings.io/docs/gateway/introduction/)
20+
- [Installation](https://webthings.io/docs/gateway/installation/)
21+
- [Development](https://webthings.io/docs/gateway/hacking/)
2422
- [Wiki](https://github.com/WebThingsIO/wiki/wiki)
25-
- [Various other docs](https://webthings.io/docs/)
2623

2724
## Community
28-
29-
- [Discourse](https://discourse.mozilla.org/c/iot)
30-
- [Matrix](https://matrix.to/#/#iot:mozilla.org) (`#iot:mozilla.org`)
25+
- [Community](https://webthings.io/community)
26+
- [Discourse](https://discourse.mozilla.org/c/iot)
27+
- [Matrix](https://matrix.to/#/#iot:mozilla.org) (`#iot:mozilla.org`)
3128

3229
## Prerequisites for Building
3330

@@ -165,9 +162,9 @@ $ sudo setcap cap_net_raw+eip $(eval readlink -f `which python3`)
165162

166163
```
167164
$ node --version
168-
v10.23.0
165+
v20.19.6
169166
$ npm --version
170-
6.14.9
167+
10.8.2
171168
```
172169

173170
Note: these versions might differ from the LTS version installed locally.
@@ -219,23 +216,6 @@ $ sudo setcap cap_net_raw+eip $(eval readlink -f `which python3`)
219216
220217
- Load https://localhost:4443 in your web browser (or use the server's IP address if loading remotely). Since you're using a self-signed certificate, you'll need to add a security exception in the browser.
221218
222-
## Browser Support
223-
224-
The Gateway requires a browser that supports:
225-
- [Fetch](https://caniuse.com/fetch)
226-
- [Web Sockets](https://caniuse.com/websockets)
227-
- [ECMAScript 2015 (ES6)](https://caniuse.com/es6)
228-
- [CustomEvent](https://caniuse.com/customevent)
229-
- [Custom Elements (V1)](https://caniuse.com/custom-elementsv1)
230-
- [Shadow DOM (V1)](https://caniuse.com/shadowdomv1)
231-
232-
Currently, that translates roughly to:
233-
- Firefox 63+
234-
- Chrome 54+
235-
- Edge 79+
236-
- Safari 10.1+
237-
- Opera 41+
238-
239219
## Debugging
240220
241221
If you are using VS Code, simply use the "launch" target. It will build the gateway in debugger mode.

0 commit comments

Comments
 (0)