---
sidebar_position: 1
slug: /
---

# Introduction

:::warning Documentation not finished
This documentation is still in development.

Some examples might be missing.
:::

awSQL is a fast and reliable database query tool.

It is designed to minimize the risk of sql-injections while maximizing usability and safety.

It prevents you from altering a whole set of rows by accident.

awSQL is designed to programmatically work with databases in an obvious manner. No more writing pesky and confusing sql-queries.

## Getting Started

To get started all you need is:

- An hosted database
  - Your credentials

To install `awSQL` you can use npm:

```shell
npm i git+https://git.pwcca.eu/Sam/awSQL.git#release
```

- Please make sure to use the #release branch to not download the dev-version.

## Exports

awSQL exports 2 modules to use:

- [awSQL](./classes/awSQL) as an instance
- [Structure](./classes/structure)

