chore: docs wip

Author: Julien-R44

README.md

@@ -16,31 +16,33 @@
 
 See documentation at [verrou.dev](https://verrou.dev/docs/introduction)
 
-## Why Verrou ?
+## Why Verrou ? 
 
-Simply because there is no alternative in the Javascript Ecosystem. Main goal of Verrou is to provide a simple and unified API to use locks, no matter the driver. It brings some benefits, like being able to switch from one driver to another without changing your code. Also being able to switch to an in-memory driver in test environment to make your tests faster and easier to write ( No infrastructure to setup ).
+Main advantage of Verrou is that it provides a consistent API across all drivers. This means that you can switch from one driver to another without having to change your code. It also means you can switch to an in-memory in your test environment, making tests faster and easier to setup (no infrastructure or anything fancy to setup).
 
-We also provide a modern API, using `async/await` and `using` to make your code sexy and easy to read.
+Having a consistent API also means that you don't have to learn a new API when switching from one driver to another. Today, in the node ecosystem, we have different npm packages to manage locks, but they all have differents APIs and behaviors.
+
+But having a consistent API doesn't mean having a less powerful API. Verrou provides every features you would expect from a locking library, and even more.
 
 ## Basic usage
 
 ```ts
-import { Verrou } from 'verrou'
-import { redisStore } from 'verrou/drivers/redis'
-import { memoryStore } from 'verrou/drivers/memory'
+import { Verrou } from '@verrou/core'
+import { redisStore } from '@verrou/core/drivers/redis'
+import { memoryStore } from '@verrou/core/drivers/memory'
 
-const lock = new Verrou({
+const verrou = new Verrou({
   default: 'redis',
   drivers: {
-    redis: redisStore(),
-    memory: memoryStore()
+    redis: { driver: redisStore() },
+    memory: { driver: memoryStore() }
   }
 })
 
-// Lock a resource
-await lock.createLock('my-resource').run(async () => {
+// Lock a resource and run a function
+await verrou.createLock('my-resource').run(async () => {
   await doSomething()
-}) // Lock is automatically released after the callback
+}) // Lock is automatically released
 ```
 
 ## Sponsor 

docs/content/docs/bentocache_flow.webp

@@ -12,63 +12,9 @@
     "category": "Guides"
   },
   {
-    "permalink": "walkthrough",
-    "title": "Walkthrough",
-    "contentPath": "./walkthrough.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "options",
-    "title": "Options",
-    "contentPath": "./options.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "cache-drivers",
-    "title": "Cache drivers",
-    "contentPath": "./cache_drivers.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "multi-tier",
-    "title": "Multi-Tier",
-    "contentPath": "./multi_tier.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "methods",
-    "title": "Methods",
-    "contentPath": "./methods.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "namespaces",
-    "title": "Namespaces",
-    "contentPath": "./namespaces.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "named-caches",
-    "title": "Named caches",
-    "contentPath": "./named_caches.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "grace-periods",
-    "title": "Grace periods",
-    "contentPath": "./grace_periods.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "timeouts",
-    "title": "Timeouts",
-    "contentPath": "./timeouts.md",
-    "category": "Guides"
-  },
-  {
-    "permalink": "stampede-protection",
-    "title": "Stampede protection",
-    "contentPath": "./stampede_protection.md",
+    "permalink": "drivers",
+    "title": "Drivers",
+    "contentPath": "./drivers.md",
     "category": "Guides"
   },
   {
@@ -84,27 +30,9 @@
     "category": "Digging Deeper"
   },
   {
-    "permalink": "plugin-prometheus",
-    "title": "Prometheus",
-    "contentPath": "./plugins/prometheus.md",
-    "category": "Plugins"
-  },
-  {
-    "permalink": "custom-cache-driver",
-    "title": "Create a custom cache driver",
-    "contentPath": "./extend/custom_cache_driver.md",
-    "category": "Extend"
-  },
-  {
-    "permalink": "custom-bus-driver",
-    "title": "Create a custom bus driver",
-    "contentPath": "./extend/custom_bus_driver.md",
-    "category": "Extend"
-  },
-  {
-    "permalink": "create-plugin",
-    "title": "Create a plugin",
-    "contentPath": "./extend/create_plugin.md",
+    "permalink": "custom-lock-store",
+    "title": "Create a custom lock store",
+    "contentPath": "./extend/custom_lock_store.md",
     "category": "Extend"
   }
 ]