From ac78d3718c6973af9ae68f5bea57ded4f971e1de Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sat, 8 Jun 2024 19:57:37 -0400 Subject: [PATCH] Add instructions to README --- .gitattributes | 5 ++++- README.md | 12 ++++++++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.gitattributes b/.gitattributes index a929ee8..cd43aad 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,4 @@ -/test export-ignore +.gitignore export-ignore +.gitattributes export-ignore +composer.lock export-ignore +tests/**/* export-ignore diff --git a/README.md b/README.md index f77d860..174f327 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ -# pdo-document +# PDODocument -Bit Badger Documents PHP implementation with PDO \ No newline at end of file +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.