edudb/README.md

A synchronous JSON based database

# EduDB
EduDB is the public version for Edu repository (soon) and works as a database. It is JavaScript friendly, importing JSON files as objects in a synchronous way by using NodeJS (v8.12).

## Getting started
To install it, you have two options: cloning directly to your machine or downloading via npm:

**Using npm**
```
npm i edudb
```

**Then import**
```javascript
const db = require('edudb');
```

And that's all! That simple and that easy.

## Documentation
For documentation and others, you can find everything on the [wiki](https://github.com/SebastianLeytonM/EduDB/wiki) section.
Remember to post issues if needed to make the database better!

## Usages
The database was made while working on a project so it has and will have everything that is required to get an application running correctly in terms of data management.

Maybe, in the future it'll also work as a server to support bigger projects.

## Authors
* **Sebastián Leyton M** - Main developer. Since 10/15/18.

If you are a contributor you will appear here if you want to! :)

## License
If you use the database, please make sure you follow the rules in [LICENSE](https://github.com/SebastianLeytonM/EduDB/blob/master/LICENSE) file but most importantly, notice me if you're going to distribute or use it on your project. That'll be awesome!

That's all, get it and enjoy!