2.0.0

Reviewed-on: #6

README.md

@@ -4,19 +4,37 @@
 
 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

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remotestorage-module-chat-messages",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Stores chat messages in daily archive files",
   "main": "./dist/build.js",
   "scripts": {
@@ -12,9 +12,10 @@
   },
   "author": "Kosmos Contributors <mail@kosmos.org> (https://kosmos.org)",
   "license": "MIT",
+  "homepage": "https://gitea.kosmos.org/kosmos/rs-module-chat-messages",
   "repository": {
     "type": "git",
-    "url": "https://github.com/67P/remotestorage-module-chat-messages.git"
+    "url": "https://gitea.kosmos.org/kosmos/rs-module-chat-messages.git"
   },
   "devDependencies": {
     "@babel/core": "^7.14.8",