diff --git a/README.md b/README.md new file mode 100644 index 0000000..109625d --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# BitBadger.Documents + +This library provides a lightweight document storage implementation backed by either PostgreSQL or SQLite. Both of these databases have great support for storing, retrieving, and manipulating JSON fields; this library leverages that, and provides a straightforward way to store documents. + +## NuGet Packages +| PostgreSQL | SQLite | +|------------|--------| +|[![Nuget](https://img.shields.io/nuget/v/BitBadger.Documents.Postgres?style=plastic)](https://www.nuget.org/packages/BitBadger.Documents.Postgres/)|[![Nuget](https://img.shields.io/nuget/v/BitBadger.Documents.Sqlite?style=plastic)](https://www.nuget.org/packages/BitBadger.Documents.Sqlite/)| + +## More Information + +See [the project site](https://bitbadger.solutions/open-source/relational-documents/) for a full description and documentation.