Skip to content

Commit

Permalink
Prepeared first release
Browse files Browse the repository at this point in the history
  • Loading branch information
Thejuse committed Jun 26, 2019
1 parent 02fc583 commit f3f144f
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 1 deletion.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.0.0] - 2019-06-26
- Initial Release
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
# scooterquotes
# Scooter Quotes
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/jseidlAT/)
> The best Scooter quotes from H.P. Baxxter. We have it all!
## Features
- Display random Quotes of Scooter
- JSON API of all Quotes
- API for displaying Random Quote

## Usage
### Installation

#### Manual Installation (FTP required)
- Download scooterQuotes via Github
- Go to your FTP and navigate to your root directory
- Setup the config `config/config.php`
- Done

## Help supporting further development

**HOW?** Ther are multiple ways to support the further development
- **PayPal** Support me on [paypal.com](https://www.paypal.me/jseidlAT)
- **BuyMeACoffee** Support me on [buymeacoffee.com](https://www.buymeacoffee.com/jseidl)

## Administartion corner

### Versions and support

| scooterQuotes| PHP | Support/Development |
| ------------ | --------- | ------------------------------------ |
| 1.x | 7.0 - 7.2 | Features, Bugfixes, Security updates |

### Changelog

Please look [here in the changelog.md](https://github.com/Thejuse/scooterquotes/blob/master/CHANGELOG.md)

### Release Management
scooterquotes uses semantic versioning which basically means for you, that

- **bugfix update**s (e.g. 1.0.0 => 1.0.1) just includes small bugfixes or security relevant stuff without breaking changes.
- **minor updates** (e.g. 1.0.0 => 1.1.0) includes new features and smaller tasks without breaking changes.
- **major updates** (e.g. 1.0.0 => 2.0.0) breaking changes wich can be refactorings, features or bugfixes.

© 2019 [Julian Seidl](https://www.jseidl.at)

0 comments on commit f3f144f

Please sign in to comment.