Skip to content

Commit

Permalink
added installation to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LiamPerson committed Jun 30, 2022
1 parent 3e418a4 commit f8e33c5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# LocalDatabase
<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>

# Installation
Either:
- **Modules:** Include the `LocalDatabase.js`, `ColumnSchema.js`, `TableSchema.js`, `DatabaseSchema.js` files in your project and import the LocalDatabase file:
```js
import LocalDatabase from './LocalDatabase';
```
- **HTML Script:** Include the LocalDatabase.all.js file and import like so:
```html
<script src="LocalDatabase.all.js"></script>
```

# Inserting & Updating

Expand Down

0 comments on commit f8e33c5

Please sign in to comment.