Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robweber committed Nov 7, 2023
1 parent ab693b9 commit 290b379
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## Version 0.2.0

### Fixed

- fixed bug where canceling dialogs would erase current setting - thanks @Shredder5262

### Changed

- Kodi python lib now moved to Nexus compatible
- workflows now use GitHub Actions instead of TravisCI

## [Version 0.1.7](https://github.com/robweber/cronxbmc/compare/matrix-0.1.6...robweber:matrix-0.1.7) - 2023-3-02

Expand Down
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Cron for Kodi
![Kodi Version](https://img.shields.io/endpoint?url=https%3A%2F%2Fweberjr.com%2Fkodi-shield%2Fversion%2Frobweber%2Fcronxbmc%2Fmatrix%2Ftrue%2Ftrue)
[![Build Status](https://img.shields.io/travis/com/robweber/cronxbmc/matrix)](https://app.travis-ci.com/github/robweber/cronxbmc)
[![Build Status](https://img.shields.io/github/actions/workflow/status/robweber/cronxbmc/addon-checker.yml)](https://github.com/robweber/cronxbmc/actions/workflows/addon-checker.yml)
[![License](https://img.shields.io/github/license/robweber/cronxbmc)](https://github.com/robweber/cronxbmc/blob/master/LICENSE.txt)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
Expand All @@ -20,6 +21,17 @@ This addon consists of a plugin and a service that will let you schedule various

Additionally you can specify your timer to display a notification when they run.

## Table Of Contents

- [Install](#install)
- [Usage](#usage)
- [Running The Addon](#running-the-addon)
- [Import Into Another Addon](#import-into-another-addon)
- [Manual Editing](#manual-editing)
- [Using Cron](#using-cron)
- [Contributing](#contributing)
- [License](#license)

## Install

This can easily be installed in Kodi via [a zip file](https://github.com/robweber/cronxbmc/archive/refs/heads/matrix.zip).
Expand Down Expand Up @@ -72,9 +84,9 @@ manager.addJob(job) #call this to create new or update an existing job
Do not attempt to assign a job ID manually. For a new job leave the ID as is, for a current job just call ```manager.addJob()``` and the id will be used to update the correct entry. Refresh jobs ```jobs = manager.getJobs()``` will pull in any new jobs that may have been added via other methods.


### Manually Editing the cron.xml file
### Manual Editing

If you need to you can bypass the GUI and write the cron.xml file yourself, or via a script.
If you need to you can bypass the GUI and write the `cron.xml` file yourself, or via a script.

The file should have the following layout:

Expand Down Expand Up @@ -103,8 +115,8 @@ Example:

## Contributing

Please use the [Issues area](https://github.com/robweber/cronxbmc/issues) of the repository to ask questions or submit bug reports. Pull Requests are accepted, please follow the normal [Github workflow](https://docs.github.com/en/get-started/quickstart/github-flow) for submitting PRs.
Please use the [Issues area](https://github.com/robweber/cronxbmc/issues) of the repository to ask questions or submit bug reports. Pull Requests are accepted, please follow the normal [Github workflow](https://docs.github.com/en/get-started/quickstart/github-flow) for submitting PRs.

## License

[MIT](/LICENSE)
[MIT](/LICENSE)

0 comments on commit 290b379

Please sign in to comment.