bit-badger/pdo-document
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 16 Wiki Activity

Add instructions to README

Browse Source
This commit is contained in:
Daniel J. Summers 2024-06-08 19:57:37 -04:00
parent 3f038b02fd
commit ac78d3718c
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.gitattributes vendored
View File

@ -1 +1,4 @@
/test export-ignore
.gitignore export-ignore
.gitattributes export-ignore
composer.lock export-ignore
tests/**/* export-ignore

12
README.md
View File

@ -1,3 +1,11 @@
# pdo-document
# PDODocument
Bit Badger Documents PHP implementation with PDO
This library allows SQLite (and, by v1.0.0-beta1, PostgreSQL) to be treated as a document database. It is a PHP implementation of the .NET [BitBadger.Documents](https://git.bitbadger.solutions/bit-badger/BitBadger.Documents) library.
## Add via Composer
`compose require bit-badger/pdo-document`
## Usage
Documentation for this library is not complete; however, its structure is very similar to the .NET version, so [its documentation will help](https://bitbadger.solutions/open-source/relational-documents/basic-usage.html) until its project specific documentation is developed. Things like `Count.All()` become `Count::all`, and all the `byField` operations are named `byFields` and take an array of fields.