commit bf6cd29d198a923b138b8754673816efcb7ec296
parent be175f2cb68702f1a958fa207d5b8db67dfed3f8
Author: finwo <finwo@pm.me>
Date: Tue, 6 Nov 2018 09:32:23 +0100
linkified references in readme
Diffstat:
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
# autolevel
-> Automatically use the right abstract-leveldown module for your configuration
+> Automatically use the right [abstract-leveldown][abstract-leveldown] module for your configuration
[](https://gitlab.com/finwo/autolevel/commits/master)
[](https://gitlab.com/finwo/autolevel/commits/master)
@@ -20,8 +20,9 @@ npm install --save autolevel levelup leveldown mongodown memdown sqldown mssql m
## Why
I was tired of looking for which combination of modules to install every time I started a new project for myself or
-work. This is simply a documented wrapper for common abstract-leveldown adapters, passing options to the used
-abstract-leveldown module and returning a levelup instance.
+work using [leveldb][leveldb]. This is simply a documented wrapper for common [abstract-leveldown][abstract-leveldown]
+adapters, passing options to the used [abstract-leveldown][abstract-leveldown] module and returning a [levelup][levelup]
+instance.
Below you'll find which extra dependencies you'd need to connect to certain backends.
@@ -68,7 +69,9 @@ db = autolevel('mysql://username:password@host:3306/database');
- multilevel + auth + manifest support
+[abstract-leveldown]: https://npmjs.com/package/abstract-leveldown
[level]: https://npmjs.com/package/level
+[leveldb]: http://leveldb.org/
[levelup]: https://npmjs.com/package/levelup
[leveldown]: https://npmjs.com/package/leveldown
[mongodown]: https://npmjs.com/package/mongodown