web/cryptpad
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add a note about installing storage adaptors from npm

Browse Source
This commit is contained in:
ansuz
2016-10-20 11:29:26 +02:00
parent 46c5f64369
commit 78f8286fe3
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
storage/README.md
View File

@@ -7,6 +7,8 @@ There are a few guidelines for creating a module:
Dependencies for your storage engine **should not** be added to Cryptpad.
Instead, write an adaptor, and place it in `cryptpad/storage/yourAdaptor.js`.
Alternatively, storage adaptors can be published to npm, and required from your config (once installed).
## Your adaptor should conform to a simple API.
It must export an object with a single property, `create`, which is a function.