Skip to content

Commit f8e33c5

Browse files
committed
added installation to readme
1 parent 3e418a4 commit f8e33c5

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# LocalDatabase
22
<h3>A simple front-end embedded database that wraps <a href="https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API">IndexedDB</a>.</h3>
33

4+
# Installation
5+
Either:
6+
- **Modules:** Include the `LocalDatabase.js`, `ColumnSchema.js`, `TableSchema.js`, `DatabaseSchema.js` files in your project and import the LocalDatabase file:
7+
```js
8+
import LocalDatabase from './LocalDatabase';
9+
```
10+
- **HTML Script:** Include the LocalDatabase.all.js file and import like so:
11+
```html
12+
<script src="LocalDatabase.all.js"></script>
13+
```
414

515
# Inserting & Updating
616

0 commit comments

Comments
 (0)