Browse Source

add a note about installing storage adaptors from npm

master
ansuz 4 years ago
parent
commit
78f8286fe3
1 changed files with 2 additions and 0 deletions
  1. 2
      storage/README.md

2
storage/README.md

@ -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.

Loading…
Cancel
Save