Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Riimu committed Oct 8, 2018
1 parent c6bc19f commit 35275da
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "A minimalistic database abstraction that provides convenience and structure",
"keywords": [
"database",
"abstraction",
"orm",
"framework"
],
Expand Down

0 comments on commit 35275da

Please sign in to comment.