diff --git a/apps/cli/README.md b/apps/cli/README.md new file mode 100644 index 000000000..d8a83c53e --- /dev/null +++ b/apps/cli/README.md @@ -0,0 +1,44 @@ +# Ontime CLI + +![Ontime](https://github.com/cpvalente/ontime/blob/9e63261b350e5b7b61c7ffb17c9e75a6c5a8c711/.github/aux-images/editor.png) +> Ontime is an application for managing rundown and event timers. + +Congratulations! You got this far into Ontime's rabbit hole and want to manage your installation. + +The CLI tool is a fast and lightweight way of installing Ontime and is perfect for self-hosting and headless installs. + +## Getting started + +### Prerequisites +You will need to have installed the correct version of node.js +Please check [the app engines declaration](https://github.com/cpvalente/ontime/blob/master/package.json) for the correct version. + +### Running Ontime +To get Ontime running, all you need to do is install it in your system using your package manager of choice: + +Install globally in your system +```bash +npm install -g @getontime/cli +``` + +... and run using the installed script +```bash +ontime +``` + +Or install and run ontime (the installation here is temporary for the duration of the session) +```bash +npx install @getontime/cli +``` + +## Links +- [Ontime's repository](https://github.com/cpvalente/ontime) +- [Ontime's documentation](https://docs.getontime.no/) +- [Ontime's website](https://getontime.no/) + +## Sponsoring +You can help the development of this project or say thank you with a one time donation. \ +See the [terms of fonations](https://github.com/cpvalente/ontime/blob/master/SPONSOR.md) + +[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/cpvalente) +[![](https://img.shields.io/static/v1?label=Buy%20me%20a%20coffee&message=%E2%9D%A4&logo=buymeacoffee&color=%23fe8e86)](https://www.buymeacoffee.com/cpvalente)