Skip to content

Commit 99044d3

Browse files
committed
docs: update README
1 parent 0519d46 commit 99044d3

1 file changed

Lines changed: 4 additions & 16 deletions

File tree

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# @rsbuild/plugin-basic-ssl
22

3-
@rsbuild/plugin-basic-ssl is a Rsbuild plugin to do something.
3+
Generate an untrusted, self-signed certificate for the HTTPS server.
4+
5+
The Basic SSL plugin will automatically generate a self-signed certificate and set the [server.https](https://rsbuild.dev/config/server/https) option. When you visit the page, your browser will indicate that the certificate is not trusted. You can access the HTTPS page after manually confirming this.
46

57
<p>
68
<a href="https://npmjs.com/package/@rsbuild/plugin-basic-ssl">
@@ -28,21 +30,7 @@ export default {
2830
};
2931
```
3032

31-
## Options
32-
33-
### foo
34-
35-
Some description.
36-
37-
- Type: `string`
38-
- Default: `undefined`
39-
- Example:
40-
41-
```js
42-
pluginBasicSsl({
43-
foo: "bar",
44-
});
45-
```
33+
Then visit the https URL of the page, and confirm in your browser.
4634

4735
## License
4836

0 commit comments

Comments
 (0)