Skip to content

Commit 83608cf

Browse files
committed
Rearrange docs and apply patches
1 parent 53a9fba commit 83608cf

File tree

3 files changed

+67
-101
lines changed

3 files changed

+67
-101
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
Record videos in contact forms!
1515

1616
Finally you can encode any webcam recordings from modern browsers and mobiles into MP4 + WebM within seconds.
17-
This without the need for Flash, Java nor any other plugins / addons. Just TypeScript, compiled into ESM (ES2022) with their declarations.
17+
This without the need for Flash, Java nor any other plugins / addons. Just TypeScript, compiled into ESM with their declarations.
1818

19+
- <a href="#demo">Live Demo/a>
1920
- <a href="#storybook">Storybook (examples)</a>
20-
- <a href="#demo">Demo / Fully working version</a>
2121
- <a href="#options">Options</a>
2222
- <a href="#api">API</a>
2323
- <a href="#form">Form Submissions</a>
@@ -27,31 +27,35 @@ This without the need for Flash, Java nor any other plugins / addons. Just TypeS
2727
- <a href="#addons">Addons</a>
2828
- <a href="#notes">Notes</a>
2929

30-
<a name="storybook"></a>
30+
<a name="demo"></a>
3131

32-
## Storybook (examples)
32+
## Live Demo
3333

34-
To check out some examples in your browser, just run these two commands:
34+
Want a play with the latest videomail-client version? ‍️⛹🏼<br/>
35+
Sure, the playground is yours on [videomail-client.netlify.app](https://videomail-client.netlify.app)
3536

36-
1. `npm install`
37-
2. `npm run storybook`
37+
### Real world usages
3838

39-
That's it. Easy as apple pie.
39+
There is a full version with all its features on [videomail.io](https://videomail.io).
4040

41-
<a name="demo"></a>
41+
And there is more:
4242

43-
## Demo
43+
- https://wfdeaf.org/contact
44+
- https://www.deaf.org.nz/contact
45+
- ...
4446

45-
A mirror of latest videomail-client can be seen on [videomail-client.netlify.app](https://videomail-client.netlify.app)
47+
And many more out there. We are rolling ...
4648

47-
### Real world usages
49+
<a name="storybook"></a>
4850

49-
Check out the full version with all its features on [videomail.io](https://videomail.io) itself. Aim is to turn this into a stable product in the near future with some external assistance.
51+
## Storybook (examples)
5052

51-
On that site I just include `import { VideomailClient} from "videomail-client"` in the app logic.
53+
To check out some examples in your browser locally, just run these two commands:
5254

53-
Another live example would be https://seeflow.co.nz/contact or https://www.deaf.org.nz/contact
54-
There are plenty if you just ask us. And way more will follow, we are rolling ...
55+
1. `npm install`
56+
2. `npm run storybook`
57+
58+
That's it. Easy as apple pie.
5559

5660
<a name="options"></a>
5761

package-lock.json

Lines changed: 43 additions & 81 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
"get-form-data": "3.0.0",
6969
"is-power-of-two": "1.0.0",
7070
"nanoevents": "9.1.0",
71-
"serialize-error": "12.0.0",
71+
"serialize-error": "13.0.0",
7272
"superagent": "10.3.0",
7373
"ua-parser-js": "2.0.8",
7474
"websocket-stream": "5.5.2"
@@ -85,7 +85,7 @@
8585
"@storybook/addon-docs": "10.1.11",
8686
"@storybook/addon-links": "10.1.11",
8787
"@storybook/html": "10.1.11",
88-
"@tsconfig/node24": "24.0.3",
88+
"@tsconfig/node24": "24.0.4",
8989
"@tsconfig/strictest": "2.0.8",
9090
"@types/defined": "1.0.2",
9191
"@types/node": "24.10.8",
@@ -112,11 +112,11 @@
112112
"prettier": "3.8.0",
113113
"prettier-plugin-curly": "0.4.1",
114114
"prettier-plugin-jsdoc": "1.8.0",
115-
"prettier-plugin-packagejson": "2.5.21",
115+
"prettier-plugin-packagejson": "2.5.22",
116116
"prettier-plugin-sh": "0.18.0",
117117
"release-it": "19.2.3",
118118
"storybook": "10.1.11",
119-
"storybook-html-rsbuild": "3.2.1",
119+
"storybook-html-rsbuild": "3.2.2",
120120
"type-fest": "5.4.1",
121121
"typescript": "5.9.3",
122122
"typescript-eslint": "8.53.0",

0 commit comments

Comments
 (0)