diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 000000000..50e60c742
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,2 @@
+github: cpvalente
+buy_me_a_coffee: cpvalente
\ No newline at end of file
diff --git a/.github/aux-images/app.png b/.github/aux-images/app.png
deleted file mode 100644
index 899ab66ce..000000000
Binary files a/.github/aux-images/app.png and /dev/null differ
diff --git a/.github/aux-images/editor.png b/.github/aux-images/editor.png
new file mode 100644
index 000000000..74c63fd62
Binary files /dev/null and b/.github/aux-images/editor.png differ
diff --git a/.github/aux-images/ontime-overview.webp b/.github/aux-images/ontime-overview.webp
new file mode 100644
index 000000000..6b80d80e9
Binary files /dev/null and b/.github/aux-images/ontime-overview.webp differ
diff --git a/.github/aux-images/overview.png b/.github/aux-images/overview.png
deleted file mode 100644
index b9b6605db..000000000
Binary files a/.github/aux-images/overview.png and /dev/null differ
diff --git a/README.md b/README.md
index 3a92c4572..1d9b1f6c2 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
-[](https://github.com/cpvalente/ontime/actions/workflows/build_v2.yml)
-[](https://www.gnu.org/licenses/gpl-3.0)
+[](https://www.gnu.org/licenses/gpl-3.0)
+
+
+[](https://github.com/sponsors/cpvalente)
+[](https://www.buymeacoffee.com/cpvalente)
## Download the latest releases here
@@ -10,146 +13,106 @@
+
+
+
+
# Ontime
-Ontime is an application for creating and managing event running order and timers.
+Ontime is an application for creating and managing event rundowns and timers.
-The user inputs a list of events along with scheduling and event information.
-This will then populate a series of screens which are available to be rendered by any device in the Network.
+### For live environments
-This makes for a simple and cheap way to distribute over a venue using a network infrastructure instead of video outputs.
+Ontime is designed for use in live environments. \
+This guides the application into being flexible and efficiently integrating into different workflows.
-
+### For teams
-
+All information added in Ontime is shared with the production team and other software / hardware in your workflow. \
+Ontime also improves team collaboration with dedicated views for cuesheets and operators, and for public and production
+signage.
+
+### Simple infrastructure
+
+All the data is distributed over the network, making its distribution and infrastructure flexible and cheap. \
+With the availability of the docker image, you can also leverage IT infrastructure to make Ontime available online for
+your team and clients.
+
+Ontime is made by video engineers and entertainment technicians.
+
+
+
+
[Read the docs to learn more](https://docs.getontime.no)
## Using Ontime
-Once installed and running, Ontime starts a background server that is the heart of all processes.
-From the app, you can add / edit your running order and control the timer playback.
+Ontime can be started by downloading the latest release for your platform. \
+Alternatively you can also use the docker image, available at [Docker Hub](https://hub.docker.com/r/getontime/ontime)
-Any device with a browser in the same network can choose one of the supported views to render the available data.
-This is done by reaching the ontime server at the _default port 4001_ eg: `localhost:4001`
-or `192.168.1.3:4001`
-
-You can then use the menu in the top left corner to select the desired view.
-The menu will be initially hidden until there is mouse interaction.
+Once installed and running, any device in the network has access to Ontime.
-In the case of unattended machines or automation, it is possible to use different URL to recall
-individual views and extend view settings using the URL presets feature
+Ontime provides different screens which allow for different types of interactions with the data. These are called
+views. \
+Each view in Ontime focuses on empowering a specific role or achieving a particular task.
+
+You can access the different views by reaching the ontime server, in your browser, at (_default port
+4001_) `http://localhost:4001` or `http://192.168.1.3:4001`
```
-For the presentation views
+For the backstage views
-------------------------------------------------------------
-IP.ADDRESS:4001 > Web server default to presenter timer view
IP.ADDRESS:4001/timer > Presenter / Stage timer view
IP.ADDRESS:4001/minimal > Simple timer view
IP.ADDRESS:4001/clock > Simple clock view
-IP.ADDRESS:4001/sm > Stage Manager / Backstage view
-IP.ADDRESS:4001/public > Public / Foyer view
-IP.ADDRESS:4001/lower > Lower Thirds
+IP.ADDRESS:4001/backstage > Stage Manager / Backstage view
+IP.ADDRESS:4001/countdown > Countdown to anything
IP.ADDRESS:4001/studio > Studio Clock
```
```
-For management views
+For the public views
+-------------------------------------------------------------
+IP.ADDRESS:4001/public > Public / Foyer view
+IP.ADDRESS:4001/lower > Lower Thirds
+```
+
+```
+For production views
-------------------------------------------------------------
IP.ADDRESS:4001/editor > the control interface, same as the app
IP.ADDRESS:4001/cuesheet > realtime cuesheets for collaboration
+IP.ADDRESS:4001/operator > automated views for operators
```
More documentation is available [in our docs](https://docs.getontime.no)
-## Feature List (in no specific order)
+## Main features
-- [x] Distribute data over network and render it in the browser
-- [x] Different screen types
- - Stage Timer
- - Minimal Timer
- - Clock
- - Backstage Info
- - Public Info
- - Studio Clock
- - Countdown
- - [Make your own?](#make-your-own-viewer)
-- [x] Configurable Lower Thirds
-- [x] Collaborative editing with the cuesheet view
-- [x] Send live messages to different screen types
-- [x] Differentiate between backstage and public data
-- [x] Workflow for managing delays
-- [x] Rich protocol integrations for Control and Feedback
- - OSC (Open Sound Control)
- - HTTP
- - WebSockets
-- [x] Roll mode: run standalone using the system clock
-- [x] [Headless run](#headless-run): run server in a separate machine, configure from a browser locally
-- [x] [Countdown to anything!](https://docs.getontime.no/features/count-to-anything/): have
- a countdown to any scheduled event
-- [x] Multi-platform (available on Windows, MacOS and Linux)
-- [x] [Companion integration](https://bitfocus.io/connections/getontime-ontime)
-
-## Unopinionated
-
-We want Ontime to be unique by targeting freelancers instead of roles.
-
-We believe most freelancers work in different fields and we want to give you a tool that you can leverage across your
-many environments and workflows.
-
-We are not interested in forcing workflows and have made Ontime so, it is flexible to whichever way you would like to
-work.
-
-## Rich APIs for workflow integrations
-
-The app is currently being developed for a broad user base, from broadcast to entertainment and
-conference halls.
-
-Taking advantage of the integrations, we currently use Ontime with:
-
-- `disguise`: trigger Ontime from d3's timeline using the **OSC API**, and **render views** using d3's
- webmodule
-- `OBS`: **render views** using the Browser Module
-- `QLab`: trigger Ontime using **OSC API**
-- `Companion`: Ontime has a **companion module**. Issue report and feature requests should be done
- in the [repository getontime/ontime](https://github.com/bitfocus/companion-module-getontime-ontime)
-
-### Make your own viewer
-
-Ontime broadcasts its data over WebSockets. This allows you to consume its data outside the application.
-
-Writing a new view for the browser can be done with basic knowledge of HTML + CSS + Javascript (or any other language
-that can run in the browser).
-
-We have prepared a few resources to help here:
-- Shipped with Ontime there is a small clock to get you started, it is available at `http://localhost:4001/external/demo` and the [code can be found here](https://github.com/cpvalente/ontime/tree/master/apps/server/src/external/demo)
-- See [this repository](https://github.com/cpvalente/ontime-viewer-template-v2) with a template on
-how to get you started
-- See information about the [Websocket API](https://docs.getontime.no/api/osc-and-ws/)
-
-More information [in the docs](https://docs.getontime.no/features/custom-views/)
-
-
-### Headless runī¸
-
-You can self-host and run Ontime in a docker image.
-
-The docker image along with documentation is [available Docker Hub at getontime/ontime](https://hub.docker.com/r/getontime/ontime)
-
-If you want to run this image in a Raspberry Pi, please see [the docs](https://docs.getontime.no/additional-notes/use-with-rpi/)
+* [x] Distribute data over network and render it in the browser
+* [x] Collaborative
+* [x] Extendable
+* [x] Send messages to different screen types
+* [x] Differentiate between backstage and public data
+* [x] Workflow for managing delays
+* [x] Rich protocol integrations for Control and Feedback
+* [x] For servers: use docker to run Ontime in in a server, configure from a browser anywhere
+* [x] Multi-platform (available on Windows, MacOS and Linux)
+* [x] Companion integration [follow link](https://bitfocus.io/connections/getontime-ontime)
## Roadmap
### Continued development
-Several features are planned in the roadmap, and we continuously adjust this to match how users interact with the app.
-
+Ontime is under active development. We continue adding and tweaking features in collaboration with users.
+
Have an idea? Reach out via [email](mail@getontime.no)
or [open an issue](https://github.com/cpvalente/ontime/issues/new)
### Issues
-We use Github's issue tracking for bug reporting and feature requests.
+We use Github's issue tracking for bug reporting and feature requests. \
Found a bug? [Open an issue](https://github.com/cpvalente/ontime/issues/new).
#### Unsigned App
@@ -169,13 +132,15 @@ or in Linux
You can circumvent this by allowing the execution of the app manually.
- In Windows: click more and select "Run Anyway"
-- in macOS: the solution in macOS is different across versions, please refer to the [apple documentation](https://support.apple.com/en-gb/guide/mac-help/mh40616/mac)
+- in macOS: the solution in macOS is different across versions, please refer to
+ the [apple documentation](https://support.apple.com/en-gb/guide/mac-help/mh40616/mac)
- In Linux: right-click the AppImage file -> Properties -> Permissions -> select Allow Executing
File as a Program
-Long story short: Ontime app is unsigned. Purchasing the certificates for both Mac and Windows
-would mean a recurrent expense and is not a priority. This is unlikely to change in future. If you
-have tips on how to improve this or would like to sponsor the code signing,
+Long story short: Ontime app is unsigned. \
+Purchasing the certificates for both Mac and Windows would mean a recurrent expense and is not a priority. \
+This is unlikely to change in future. \
+If you have tips on how to improve this or would like to sponsor the code signing,
please [open an issue](https://github.com/cpvalente/ontime/issues/new)
#### Safari
@@ -187,19 +152,29 @@ There are known issues with Safari versions lower than 13:
There is no plan for any further work on this.
-# Contributing
+## Contributing
Looking to contribute? All types of help are appreciated, from coding to testing and feature specification.
-
+
If you are a developer and would like to contribute with some code, please open an issue to discuss before opening a
Pull Request.
-
+
Information about the project setup can be found in the [development documentation](./DEVELOPMENT.md)
-# Help
+## Help
Help is underway! ... and can be found [here](https://docs.getontime.no)
-# License
+## License
This project is licensed under the terms of the GNU GPL v3
+
+## SPONSOR
+
+You can help the development of this project or say thank you with a one time donation. \
+See [the terms of donations](https://github.com/cpvalente/ontime/blob/master/.github/FUNDING.md).
+
+
+
+
+
diff --git a/SPONSOR.md b/SPONSOR.md
new file mode 100644
index 000000000..f8a262ea4
--- /dev/null
+++ b/SPONSOR.md
@@ -0,0 +1,19 @@
+# Terms of sponsorship
+Ontime does not exist as a fiscal entity. The sponsorship recipient is the project owner. In this light, contributors are funding the project owner's capacity to work on the project, not the project itself. As a contribution recipient, the code owner reserves the right to redistribute.
+
+## Why sponsor
+Ontime is and will remain free, regardless of your decision to contribute.
+Regardless, you may choose to provide a monetary contribution:
+
+### Improve user experience
+Certain parts of the application user experience are tied to our capacity to pay for services. App signing and Google Sheets integration are good examples of this.
+
+### Cool stuff
+We may choose not to implement some features. This could be related to the complexity required, to the skill set, or to the fact that we just feel it doesn't improve the app for a significant percentage of users. In those cases, a feature may be considered "not worth it," regardless of its pertinence.
+
+As a user, you can choose to sponsor a particular feature or donate to the app so that we can create bounties for features.
+
+### Priorities
+Monetary contributions are most immediately needed to offset the costs of presenting and distributing Ontime, i.e., hosting, domains, and certificates.
+
+Additional funding will be considered according to the needs at the time.