chore: Add README
This commit is contained in:
25
README.md
Normal file
25
README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Db Builder
|
||||
|
||||
This package enables you to create your SQLite database from a json file
|
||||
that represent your tables.
|
||||
|
||||
## Warnings
|
||||
|
||||
DO NOT USE IN PRODUCTION ENVIRONNEMENT, this lib is quickly developed for my personal use !
|
||||
|
||||
## Usage
|
||||
|
||||
To use this lib, you need to call the facade struct `DbBuilderFacade` and give it
|
||||
the database path (the db file is created if needed) and the path to the json file that represent your db.
|
||||
|
||||
Exemple:
|
||||
```rust
|
||||
fn main() {
|
||||
let facade = DbBuilderFacade{};
|
||||
|
||||
match facade.build("schema.json".to_string(), "exemple.db".to_string()) {
|
||||
Ok(_) => println!("DB created"),
|
||||
Err(message) => eprintln!("Error creating the db: {}", message)
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user