feat: add readme

Author: darkskygit

README.md

@@ -0,0 +1,55 @@
+# sqlite-vfs-http
+
+The `sqlite-vfs-http` is a library based on the SQLite VFS extension, designed to access static SQLite files located on a CDN via HTTP/HTTPS protocol.
+
+By using this library, you can host SQLite database files on a remote server and perform queries without downloading the files locally.
+
+### Requirements
+
+-   any crate that link SQLite3 to your binary, such as `rusqlite`, `sqlx` or `libsqlite3-sys`
+
+### Usage
+
+1. add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+sqlite-vfs-http = "0.1.0"
+```
+
+2. use the library in your code:
+
+```rust
+use rusqlite::{Connection, NO_PARAMS};
+use sqlite_vfs_http::{register_http_vfs, HTTP_VFS};
+
+
+// Register the HTTP VFS for sqlite
+register_http_vfs();
+
+let base = "https://example.com";
+let conn = Connection::open_with_flags_and_vfs(
+    format!("{base}/0.db"),
+    OpenFlags::SQLITE_OPEN_READ_WRITE
+        | OpenFlags::SQLITE_OPEN_CREATE
+        | OpenFlags::SQLITE_OPEN_NO_MUTEX,
+    // Use HTTP VFS
+    HTTP_VFS,
+)?;
+conn.query_row(
+    "SELECT count(1) FROM sqlite_master WHERE type = 'table'",
+    [], |row| row.get::<usize>(0)
+).unwrap();
+```
+
+### Limitations
+
+-   Before uploading to the CDN, the database needs to change the journal mode to `MEMORY`:
+
+```sql
+PRAGMA journal_mode = MEMORY;
+```
+
+### License
+
+> This project is licensed under the AGPL-3.0 license.

src/lib.rs

@@ -1,16 +1,16 @@
 mod buffer;
 mod conn;
-mod http;
 mod utils;
+mod vfs;
 
 use buffer::LazyBuffer;
 use conn::Connection;
-use http::HttpVfs;
 use sqlite_vfs::register;
 use std::sync::{Arc, Once, RwLock};
 use utils::AtomicRuntime;
+use vfs::HttpVfs;
 
-pub use http::HTTP_VFS;
+pub use vfs::HTTP_VFS;
 
 pub fn register_http_vfs() {
     const ONCE: Once = Once::new();

src/http.rs src/vfs.rssrc/http.rs renamed to src/vfs.rs

@@ -163,7 +163,7 @@ mod tests {
     #[tokio::test]
     async fn test_http_vfs() {
         init_server(|base| async move {
-            super::register_http_vfs();
+            vfs::register_http_vfs();
 
             {
                 let conn = Connection::open_with_flags_and_vfs(