Add README

Author: Joy-less

README.md

@@ -1,2 +1,65 @@
 # SQLiteSharp
- A fork of SQLite-net.
+
+SQLiteSharp is a powerful library to help you access a SQLite database in C#.
+
+## Features
+
+- Create tables from your .NET objects
+- Manage your database with SQL commands and No-SQL functions
+- Use synchronous and asynchronous APIs
+- Encrypt your database with a password or key
+
+## Background
+
+This project is based on [SQLite-net](https://github.com/praeclarum/sqlite-net) by Krueger Systems Inc.
+
+The purpose of SQLiteSharp is to provide improvements to the original library, which is outdated in many ways.
+
+## Example
+
+```cs
+public class ShopItem {
+    [PrimaryKey, AutoIncrement]
+    public long Id { get; set; }
+
+    [NotNull]
+    public string? ItemName { get; set; }
+
+    public long Count { get; set; }
+
+    [Ignore]
+    public int SomethingToIgnore { get; set; }
+}
+```
+
+```cs
+// Open a database connection
+using SQLiteConnection Connection = new("database.db");
+
+// Create a table for a class
+Connection.CreateTable<ShopItem>();
+
+// Delete all existing items in the table
+Connection.DeleteAll<ShopItem>();
+
+// Insert items into the table
+Connection.Insert(new ShopItem() {
+    ItemName = "Apple",
+    Count = 10,
+});
+Connection.Insert(new ShopItem() {
+    ItemName = "Banana",
+    Count = 5,
+});
+
+// Find one item in the table matching a predicate
+ShopItem? Apple = Connection.Find<ShopItem>(ShopItem => ShopItem.ItemName == "Apple");
+Assert.NotNull(Apple);
+
+// Delete an item from the table
+Connection.Delete(Apple);
+
+// Find several items in the table
+List<ShopItem> Bananas = Connection.Table<ShopItem>().Where(ShopItem => ShopItem.ItemName == "Banana").ToList();
+Assert.Single(Bananas);
+```

SQLiteSharp.Tests/UnitTest1.cs renamed to SQLiteSharp.Tests/ReadMeTest.cs

@@ -1,6 +1,6 @@
 namespace SQLiteSharp.Tests;
 
-public class UnitTest1 {
+public class ReadMeTest {
     [Fact]
     public void Test1() {
         // Open a database connection