Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Drarig29 committed Jun 16, 2021
1 parent 3314b7b commit 3a3a377
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# ts-json-db

[![NPM](https://nodei.co/npm/ts-json-db.png?downloads=true&stars=true)](https://nodei.co/npm/ts-json-db/)

A Node.js database using JSON file as storage. The result of requests are **typed**!

It's a wrapper around [node-json-db](https://github.com/Belphemur/node-json-db) which does the main job about the "database". This package is inspired by [RESTyped](https://github.com/rawrmaan/restyped) and its autocomplete and type checks.

![tst](https://i.imgur.com/q3uLHJW.gif)
![Demo](https://i.imgur.com/q3uLHJW.gif)

[![npm](https://img.shields.io/npm/v/ts-json-db.svg)](https://www.npmjs.com/package/ts-json-db)
[![Downloads](https://img.shields.io/npm/dt/ts-json-db.svg)](https://www.npmjs.com/package/ts-json-db)

## Installation

Add `ts-json-db` to your existing Node.js project.

```bash
npm install ts-json-db
```

## Example Usage
## Usage

```typescript
import TypedJsonDB, { ContentBase, Dictionary } from "ts-json-db";
Expand Down

0 comments on commit 3a3a377

Please sign in to comment.