From 3dbfd4ed74d44b9071f656427a7f1404c409b9b5 Mon Sep 17 00:00:00 2001 From: Dimitri DO BAIRRO Date: Thu, 2 May 2019 11:43:56 +0200 Subject: [PATCH] doc(README.md) documentation updated --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ca66ddb..a6520c6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # @aclify/aclify -[![Aclify](media/header.png)](https://github.com/Aclify) - +[![Aclify](media/header.png)](https://github.com/Aclify) [![Dependencies][prod-dependencies-badge]][prod-dependencies] [![Coverage][coverage-badge]][coverage] [![Build Status][travis-badge]][travis-ci] @@ -71,16 +70,16 @@ Create your acl module by requiring it and instantiating it with a valid store i **From import** ```javascript -import { Acl, MemoryStore, RedisStore, MongoDBStore } from '@aclify/aclify'; +import * as Aclify from '@aclify/aclify'; // Using Redis store -const acl = new Acl(new RedisStore(RedisClient, {prefix: 'acl_'})); +const acl = new Aclify.Acl(new Aclify.RedisStore(RedisClient, {prefix: 'acl_'})); // Or Using the Memory store -const acl = new Acl(new MemoryStore()); +const acl = new Aclify.Acl(new Aclify.MemoryStore()); // Or Using the MongoDB store -const acl = new Acl(new MongoDBStore(db, {prefix: 'acl_'})); +const acl = new Aclify.Acl(new Aclify.MongoDBStore(db, {prefix: 'acl_'})); ``` All the following functions return a Promise.