> For the complete documentation index, see [llms.txt](https://quickredis.js.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://quickredis.js.org/master.md).

# Getting Started

## Installing [Quick Redis](https://npmjs.com/package/quickredis-db)

To install [Quick Redis](https://npmjs.com/package/quickredis-db) run the following command in your project folder

```bash
npm install quickredis-db
```

## Example of [Quick Redis](https://npmjs.com/package/quickredis-db)​ <a href="#example" id="example"></a>

```javascript
// Creating the redis client
const redis = require('quickredis-db')
const client = redis.createClient()

client.once('ready', () => console.log('Connected to database'))

// Setting a value
client.set('foo', 'bar').then(console.log)// 'bar'

// Reading a value
client.get('foo').then(console.log) // 'bar'
```