3 Commits

Author SHA1 Message Date
328be7ed75 2.0.0 2021-09-13 14:08:10 +02:00
cf8c43bede Merge pull request 'Add proper README' (#6) from docs/readme into master
Reviewed-on: #6
2021-09-13 12:06:56 +00:00
188b45e778 Add proper README
* Document usage
* Update communication options for support/issues
2021-09-13 14:03:41 +02:00
5 changed files with 33 additions and 15 deletions

View File

@@ -4,19 +4,37 @@
Stores chat messages in daily archive documents. Stores chat messages in daily archive documents.
Please feel free to open GitHub issues for questions, feature requests, ## Usage
protocol proposals, and whatever else you like.
## 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 const archive = new remoteStorage.chatMessages.DailyArchive({
* XMPP 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 archive.addMessages(messages);
* Matrix ```
* Slack
* ... 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

2
dist/build.js vendored

File diff suppressed because one or more lines are too long

2
dist/build.js.map vendored

File diff suppressed because one or more lines are too long

2
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{ {
"name": "remotestorage-module-chat-messages", "name": "remotestorage-module-chat-messages",
"version": "1.0.1", "version": "2.0.0",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

View File

@@ -1,6 +1,6 @@
{ {
"name": "remotestorage-module-chat-messages", "name": "remotestorage-module-chat-messages",
"version": "1.0.1", "version": "2.0.0",
"description": "Stores chat messages in daily archive files", "description": "Stores chat messages in daily archive files",
"main": "./dist/build.js", "main": "./dist/build.js",
"scripts": { "scripts": {