Skip to content

Commit 35275da

Browse files
committed
Add readme
1 parent c6bc19f commit 35275da

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## 0.1.0 - 2018-10-08
10+
### Added
11+
- Initial development release
12+
13+
[Unreleased]: https://github.com/simply-framework/container/compare/v0.1.0...HEAD

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Database convenience layer #
2+
3+
[![Build Status](https://img.shields.io/travis/com/simply-framework/database/master.svg?style=flat-square)](https://travis-ci.com/simply-framework/database)
4+
[![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)
5+
[![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)
6+
[![Packagist](https://img.shields.io/packagist/v/simply/database.svg?style=flat-square)](https://packagist.org/packages/simply/database)
7+
8+
This package provides a partial database abstraction layer that is intended to make simple
9+
database operations more convenient while being able to write consistent and structured
10+
code with custom database queries. The purpose of this package is not to provide a complete
11+
database abstraction and will require you to write quite a bit of database specific SQL
12+
code still.
13+
14+
Therefore, this package is a database *convenience* layer rather than an abstraction layer,
15+
as it simply makes things more convenient but does not abstract away the underlying database.
16+
17+
NOTE: This package is part of a framework that is still highly experimental in nature. Stable api or proper
18+
documentation are not to be expected until the framework has been tested in practice.
19+
20+
API documentation is available at: https://docs.riimu.net/simply/database/
21+
22+
## Credits ##
23+
24+
This library is Copyright (c) 2018 Riikka Kalliomäki.
25+
26+
See LICENSE for license and copying information.

composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "A minimalistic database abstraction that provides convenience and structure",
55
"keywords": [
66
"database",
7+
"abstraction",
78
"orm",
89
"framework"
910
],

0 commit comments

Comments
 (0)