diff --git a/README.md b/README.md new file mode 100644 index 0000000..090c301 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Tutu + +Tutu is a comfortable experience for tooting. Designed to work on any device - desktop, phone and tablet. + +## Compatibility + +The code is built against those targets and Tutu must run on those platforms: + +| Firefox | Safari | iOS | Chrome | Edge | +| ------- | ------ | ----- | ------ | ---- | +| 98 | 15.4 | 15.4 | 84 | 87 | + +Tutu trys to push the Web technology to its limit. Some features might not be available on the platform does not meet the requirement. + +## Build & Depoly + +Tutu uses [bun](https://bun.sh) as the package manager. Run + +````sh +bun install && bun dist +```` + +to build the distribution, saved at "dist" directory. + +Tutu must be loaded in a secure context - that means serving under localhost (`127.0.0.1` or `::1`) or HTTPS. + +Use `bun dev` to run the dev server. By default, the dev server is run on the domain and the port you defined. The cert is provided by localhost.direct, see for detail. + +You can also change the config to make it run on localhost - but localhost.direct can be visted from the other device on the same network (as you do a little DNS magic).