diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa03fc4 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# PawSQLite Cordova Adapter + +An Apache Cordova plugin and adapter for PawSQLite. This plugin uses its own native implemenation for acessing SQLite. Currently only Android is supported, but other platforms will be added when needed. + +## Installation + +You must first install PawSQLite, and then install the plugin. + +```bash +npm install -s git+https://git.n0m.org/n0m/PawSQLite.git +cordova plugin add git+https://git.n0m.org/n0m/PawSQLite-Cordova-Adapter.git +``` + +## Usage + +For more detailed usage, please see: [PawSQLite](https://git.n0m.org/n0m/PawSQLite) + +```javascript +const PawSQLite = require("pawsqlite"); + +// PawSQLiteCordovaAdapter is automatically injected by cordova +PawSQLite.registerAdapter(PawSQLiteCordovaAdapter); + +const db = await PawSQLite.open("test", { + adapter: 'PawSQLiteCordovaAdapter' +}); + +await db.sql(` + CREATE TABLE contacts ( + contact_id INTEGER PRIMARY KEY, + first_name TEXT NOT NULL, + last_name TEXT NOT NULL + ); +`); + +const transaction = db.transaction(); + +console.log(await db.sql("SELECT * FROM contacts")); + +await transaction.sql( + "INSERT INTO contacts (first_name, last_name) VALUES (?, ?)", + "John", + "Lennon" +); + +await transaction.commit(); +``` + +## Contributing +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## License +[MIT](https://choosealicense.com/licenses/mit/) \ No newline at end of file