Skip to content

Commit 65d613d

Browse files
authored
Update README.md
1 parent 5348c50 commit 65d613d

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# SQLite CodeFirst
2+
23
**Release Build** [![Build status](https://ci.appveyor.com/api/projects/status/2qavdqctw0ehscm6/branch/master?svg=true)](https://ci.appveyor.com/project/msallin/sqlitecodefirst-nv6vn/branch/master)
34

45
**CI Build** [![Build status](https://ci.appveyor.com/api/projects/status/oc1miog385h801qe?svg=true)](https://ci.appveyor.com/project/msallin/sqlitecodefirst)
56

6-
**Support** <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=ARTMHALNW4VC6&lc=CH&item_name=SQLite%2eCodeFirst&item_number=sqlitecodefirst&currency_code=CHF&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted" title="Donate to this project using Paypal"><img src="https://camo.githubusercontent.com/11b2f47d7b4af17ef3a803f57c37de3ac82ac039/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617970616c2d646f6e6174652d79656c6c6f772e737667" alt="PayPal donate button" data-canonical-src="https://img.shields.io/badge/paypal-donate-yellow.svg" style="max-width:100%;"></a>
7+
Creates a [SQLite Database](https://sqlite.org/) from Code, using [Entity Framework](https://msdn.microsoft.com/en-us/data/ef.aspx) CodeFirst.
78

8-
To support this project you can: report bugs by creating new issues, write code and create PRs or donate.
9+
## Support the project <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=ARTMHALNW4VC6&lc=CH&item_name=SQLite%2eCodeFirst&item_number=sqlitecodefirst&currency_code=CHF&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted" title="Donate to this project using Paypal"><img src="https://camo.githubusercontent.com/11b2f47d7b4af17ef3a803f57c37de3ac82ac039/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617970616c2d646f6e6174652d79656c6c6f772e737667" alt="PayPal donate button" data-canonical-src="https://img.shields.io/badge/paypal-donate-yellow.svg" style="max-width:100%;"></a>
10+
To support this project you can: *star the repository*, report bugs/request features by creating new issues, write code and create PRs or donate.
911
Especially if you use it for a commercial project, a donation is welcome.
12+
If you need a specific feature for a commercial project, I am glad to offer a paid implementation.
1013

1114

12-
Creates a [SQLite Database](https://sqlite.org/) from Code, using [Entity Framework](https://msdn.microsoft.com/en-us/data/ef.aspx) CodeFirst.
13-
15+
## Features
1416
This Project ships several `IDbInitializer` classes. These create new SQLite Databases based on your model/code.
15-
I started with the [code](https://gist.github.com/flaub/1968486e1b3f2b9fddaf) from [flaub](https://github.com/flaub).
1617

17-
Currently the following is supported:
18+
The following features are supported:
1819
- Tables from classes (supported annotations: `Table`)
1920
- Columns from properties (supported annotations: `Column`, `Key`, `MaxLength`, `Required`, `NotMapped`, `DatabaseGenerated`, `Index`)
2021
- PrimaryKey constraint (`Key` annotation, key composites are supported)
@@ -25,12 +26,6 @@ Currently the following is supported:
2526
- Unique constraint (Decorate columns with the `UniqueAttribute`, which is part of this library)
2627
- Collate constraint (Decorate columns with the `CollateAttribute`, which is part of this library)
2728

28-
I tried to write the code in a extensible way.
29-
The logic is divided into two main parts, Builder and Statement.
30-
The Builder knows how to translate the EdmModel into statements where a statement class creates the SQLite-DDL-Code.
31-
The structure of the statements is influenced by the [SQLite Language Specification](https://www.sqlite.org/lang.html).
32-
You will find an extensive usage of the composite pattern.
33-
3429
## Install
3530
Either get the assembly from the latest [GitHub Release Page](https://github.com/msallin/SQLiteCodeFirst/releases) or install the NuGet-Package [SQLite.CodeFirst](https://www.nuget.org/packages/SQLite.CodeFirst/) (`PM> Install-Package SQLite.CodeFirst`).
3631

@@ -115,6 +110,16 @@ public class MyContext : DbContext
115110
}
116111
```
117112

113+
## Structure
114+
I tried to write the code in a extensible way.
115+
The logic is divided into two main parts, Builder and Statement.
116+
The Builder knows how to translate the EdmModel into statements where a statement class creates the SQLite-DDL-Code.
117+
The structure of the statements is influenced by the [SQLite Language Specification](https://www.sqlite.org/lang.html).
118+
You will find an extensive usage of the composite pattern.
119+
118120
## Hints
119121
If you try to reinstall the NuGet-Packages (e.g. if you want to downgrade to .NET 4.0), the app.config will be overwritten and you may getting an exception when you try to run the console project.
120122
In this case please check the following issue: https://github.com/msallin/SQLiteCodeFirst/issues/13.
123+
124+
## Recognition
125+
I started with the [code](https://gist.github.com/flaub/1968486e1b3f2b9fddaf) from [flaub](https://github.com/flaub).

0 commit comments

Comments
 (0)