Update README.md

added a table of contents
This commit is contained in:
Fabio Formosa
2022-12-04 11:49:26 +01:00
committed by GitHub
parent 4453d62515
commit ee2f80e582

View File

@@ -3,6 +3,23 @@
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/it.fabioformosa.quartz-manager/quartz-manager-starter-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/it.fabioformosa.quartz-manager/quartz-manager-starter-api)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fabioformosa_quartz-manager&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fabioformosa_quartz-manager) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=fabioformosa_quartz-manager&metric=bugs)](https://sonarcloud.io/summary/new_code?id=fabioformosa_quartz-manager) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=fabioformosa_quartz-manager&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=fabioformosa_quartz-manager) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=fabioformosa_quartz-manager&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=fabioformosa_quartz-manager)
[QUARTZ MANAGER](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#quartz-manager)
    [Quartz Manager UI](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#quartz-manager-ui)
    [Quartz Manager API](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#quartz-manager-api)
[HOW IT WORKS](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#how-it-works)
[GET STARTED](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#get-started)
    [Quartz Manager Starter API Lib](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#quartz-manager-starter-api-lib)
    [Quartz Manager Starter UI Lib](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#quartz-manager-starter-ui-lib)
    [Quartz Manager Starter Security Lib](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#quartz-manager-starter-security-lib)
    [Quartz Manager Persistence Lib](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#quartz-manager-starter-persistence-lib)
[EXAMPLES](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#examples)
[LIMITATIONS](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#limitations)
[ROADMAP](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#roadmap)
[REPOSITORY](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#repository)
[HOW TO CONTRIBUTE](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#how-to-contribute)
[SUPPORT THE PROJECT](https://github.com/fabioformosa/quartz-manager/edit/master/README.md#support-the-project)
# QUARTZ MANAGER
In the last decade, the [Quartz Scheduler](http://www.quartz-scheduler.org/) has become the most adopted opensource job scheduling library for Java applications.
@@ -38,7 +55,7 @@ In the latter case, in which there isn't an existing quartz instance, you can re
* You can enable a secure layer, if your project doesn't have any, to give access at the API and the UI only to authenticated users.
* You can enable a persistent layer, to persist the config and the progress of your trigger, in a postgresql database.
# QUICK START
# GET STARTED
**Requirements**
Java 9+, Spring Framework 5+ (Spring Boot 2.x)