docs: add section about using within templates

This commit is contained in:
Jacobtread 2024-06-25 17:55:03 +12:00
parent eb1e318ed3
commit 946c7da4f0

View file

@ -86,6 +86,19 @@ Below is an example of a PDF generated by Timekeep. These PDFs are generated usi
> [!NOTE]
> PDF export is not supported on mobile and will not be available. This is a limitation of the APIs available and is not a planned feature.
## 🔣 Using with templates
If you would like to create a timekeep through a template plugin, you can do so by using the JSON for a timekeep directly.
If you have frequently used entry names you can define them in your template by specifying `null` for both the `startTime` and `endTime`:
```json
{"entries":[{"name":"Non started block","startTime":null,"endTime":null,"subEntries":null}]}
```
This will create an entry that is not yet started which you can click the play button on and start without having to type out the name.
## 📄 License
This project is licensed under the [MIT License](./LICENSE.md)