diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e40533b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,13 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## 0.1.0 - 2018-10-08 +### Added +- Initial development release + +[Unreleased]: https://github.com/simply-framework/container/compare/v0.1.0...HEAD diff --git a/README.md b/README.md new file mode 100644 index 0000000..978e30c --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Database convenience layer # + +[![Build Status](https://img.shields.io/travis/com/simply-framework/database/master.svg?style=flat-square)](https://travis-ci.com/simply-framework/database) +[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/simply-framework/database.svg?style=flat-square)](https://scrutinizer-ci.com/g/simply-framework/database/?branch=master) +[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/simply-framework/database.svg?style=flat-square)](https://scrutinizer-ci.com/g/simply-framework/database/?branch=master) +[![Packagist](https://img.shields.io/packagist/v/simply/database.svg?style=flat-square)](https://packagist.org/packages/simply/database) + +This package provides a partial database abstraction layer that is intended to make simple +database operations more convenient while being able to write consistent and structured +code with custom database queries. The purpose of this package is not to provide a complete +database abstraction and will require you to write quite a bit of database specific SQL +code still. + +Therefore, this package is a database *convenience* layer rather than an abstraction layer, +as it simply makes things more convenient but does not abstract away the underlying database. + +NOTE: This package is part of a framework that is still highly experimental in nature. Stable api or proper +documentation are not to be expected until the framework has been tested in practice. + +API documentation is available at: https://docs.riimu.net/simply/database/ + +## Credits ## + +This library is Copyright (c) 2018 Riikka Kalliomäki. + +See LICENSE for license and copying information. diff --git a/composer.json b/composer.json index e4f50a0..bb9ff62 100644 --- a/composer.json +++ b/composer.json @@ -4,6 +4,7 @@ "description": "A minimalistic database abstraction that provides convenience and structure", "keywords": [ "database", + "abstraction", "orm", "framework" ],