Skip to content

Commit

Permalink
Add support for sqlite via SequelizeProvider, replace PostgresProvider
Browse files Browse the repository at this point in the history
  • Loading branch information
zajrik committed Jul 4, 2017
1 parent 8bb7ff9 commit 0ad5bbe
Show file tree
Hide file tree
Showing 10 changed files with 810 additions and 31 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ test_*.js
/scripts/**/*.js
/scripts/**/*.d.ts
/scripts/storage
*.sqlite
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,24 @@ is currently preferred due to the proximity to release and dependency issues in
control over the data passed to your commands
- Ships with methods for resolving different data types and ensuring
certain args/types are passed to commands
- Easy to use settings/storage with support for custom storage providers
- Ships with a default JSON provider and an optional Postgres provider
- Easy to use storage with support for custom storage providers
- Ships with a default JSON provider, and other optional providers using Sequelize:
- Postgres
- SQLite
- Full TypeScript support (It's written in it!)
- Support for decorators for simpler handling of:
- Event listeners
- Command metadata
- Command middleware assignment
- Attaching Logger for logging/debugging

## Installation
Ignore any warnings about unmet peer dependencies as they are all optional unless using a Sequelize-based storage provider.

Regular install: `npm install --save yamdbf`
With a Postgres provider: `npm install --save yamdbf pg sequelize`
With an SQLite provider: `npm install --save yamdbf sqlite3 sequelize`

## Links
- [YAMDBF Documentation](https://yamdbf.js.org)
- [YAMDBF Discord server](https://discord.gg/cMXkbXV)
Expand Down
Loading

0 comments on commit 0ad5bbe

Please sign in to comment.