Add proper README

* Document usage
* Update communication options for support/issues
This commit is contained in:
Basti 2021-09-13 14:02:31 +02:00
parent 21cb5a02c8
commit 188b45e778
Signed by untrusted user: basti
GPG Key ID: 9F88009D31D99C72

View File

@ -4,19 +4,37 @@
Stores chat messages in daily archive documents.
Please feel free to open GitHub issues for questions, feature requests,
protocol proposals, and whatever else you like.
## Usage
## Protocols
Open a daily archive and write messages to it:
### Currently supported
```js
const RemoteStorage = require("remotestoragejs");
const ChatMessages = require("remotestorage-module-chat-messages");
const remoteStorage = new RemoteStorage({ modules: [ ChatMessages ] });
* IRC
* XMPP
const archive = new remoteStorage.chatMessages.DailyArchive({
service: {
protocol: 'IRC',
domain: 'irc.libera.chat'
},
channelName: '#kosmos',
date: new Date(),
isPublic: true // Channel logs will be written to public folder
});
### Planned
const messages = [
{ "date": "2015-06-05T17:35:28.454Z", "user": "jimmy", "text": "knock knock" },
{ "date": "2015-06-05T17:36:05.123Z", "user": "walter", "text": "who's there?" }
];
* Mattermost
* Matrix
* Slack
* ...
archive.addMessages(messages);
```
See the inline source code documentation (JSDoc) for usage details and function
arguments. For a real-world integration example, see
[hubot-remotestorage-logger](https://github.com/67P/hubot-remotestorage-logger/).
## Support, bugs, feedback, questions
Come and chat with us: https://wiki.kosmos.org/Main_Page#Chat