Update README.md

11 years ago · 1defef730b
parent da633c1441
commit 1defef730b
1 changed files with 1 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -35,7 +35,7 @@ It's a subset of MongoDB's API (the most used operations). The current API will
 ### Creating/loading a database
 You can use NeDB as an in-memory only datastore or as a persistent datastore. One datastore is the equivalent of a MongoDB collection. The constructor is used as follows `new Datastore(options)` where `options` is an object with the following fields:  

-* `filename` (optional): path to the file where the data is persisted. If left blank, the datastore is automatically considered in-memory only.
+* `filename` (optional): path to the file where the data is persisted. If left blank, the datastore is automatically considered in-memory only. It cannot end with a `~` which is used in the temporary files NeDB uses to perform crash-safe writes
 * `inMemoryOnly` (optional, defaults to false): as the name implies.
 * `autoload` (optional, defaults to false): if used, the database will
  automatically be loaded from the datafile upon creation (you don't