From 6d7a10bd73890af9d490ece0a2086e5d360bd1ec Mon Sep 17 00:00:00 2001 From: Louis Chatriot Date: Sun, 8 Dec 2013 09:19:24 -0800 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b32734..d3e64fb 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ You can use NeDB as an in-memory only datastore or as a persistent datastore. On need to call `loadDatabase`). Any command issued before load is finished is buffered and will be executed when load is done. -* `nodeWebkitAppName` (optional): if you are using NeDB from whithin a Node Webkit app, specify its name (the same one you use in the `package.json`) in this field and the `filename` will be relative to the directory Node Webkit uses to store the rest of the application's data (local storage etc.). It works on Linux, OS X and Windows. +* `nodeWebkitAppName` (optional, **DEPRECATED**): if you are using NeDB from whithin a Node Webkit app, specify its name (the same one you use in the `package.json`) in this field and the `filename` will be relative to the directory Node Webkit uses to store the rest of the application's data (local storage etc.). It works on Linux, OS X and Windows. Now that you can use `require('nw.gui').App.dataPath` in Node Webkit to get the path to the data directory for your application, you should not use this option an,ymore and it will be removed. If you use a persistent datastore without the `autoload` option, you need to call `loadDatabase` manually. This function fetches the data from datafile and prepares the database. **Don't forget it!** If you use a