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

little flowey

Browse Source
This commit is contained in:
Caleb James DeLisle
2017-04-25 16:04:17 +02:00
parent 5194677443
commit 211113fb1a
8 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
storage/README.md
View File

@@ -46,14 +46,14 @@ While we migrate to our new Netflux API, only the leveldb adaptor will be suppor
## removeChannel(channelName, callback)
This method is called (optionally, see config.js.dist for more info) some amount of time after the last client in a channel disconnects.
This method is called (optionally, see config.example.js for more info) some amount of time after the last client in a channel disconnects.
It should remove any history of that channel, and execute a callback which takes an error message as an argument.
## Documenting your adaptor
Naturally, you should comment your code well before making a PR.
Failing that, you should definitely add notes to `cryptpad/config.js.dist` such that people who wish to install your adaptor know how to do so.
Failing that, you should definitely add notes to `cryptpad/config.example.js` such that people who wish to install your adaptor know how to do so.
Notes on how to install the back end, as well as how to install the client for connecting to the back end (as is the case with many datastores), as well as how to configure cryptpad to use your adaptor.
The current configuration file should serve as an example of what to add, and how to comment.