diff --git a/README.org b/README.org index 51eaee5..2e60141 100644 --- a/README.org +++ b/README.org @@ -4,7 +4,7 @@ “Etherpad is a highly customizable Open Source online editor providing collaborative editing in really real-time. Etherpad allows you to edit documents collaboratively in real-time, much like a live multi-player editor that runs in your browser. Write articles, press releases, to-do lists, etc. together with your friends, fellow students or colleagues, all working on the same document at the same time.” https://etherpad.org/ -The Etherpad API provides a way to add, delete and edit pads. It also enables access to changesets and author information required for displaying changes between revisions but doesn’t appear to provide a way to send changesets (c.f. using the API call [[https://etherpad.org/doc/v1.8.5/#index_getrevisionchangeset_padid_rev][getRevisionChangeset(padID, [rev])]] and the [[ https://etherpad.org/doc/v1.8.4/#index_changeset_library][changeset]] format) +The Etherpad API provides a way to add, delete and edit pads. It also enables access to changesets and author information required for displaying changes between revisions but doesn’t appear to provide a way to send changesets (c.f. using the API call [[https://etherpad.org/doc/v1.8.5/#index_getrevisionchangeset_padid_rev][getRevisionChangeset]] and the [[ https://etherpad.org/doc/v1.8.4/#index_changeset_library][changeset]] format) [[layered-0.jpg]] @@ -32,7 +32,7 @@ To connect to an existing etherpad server you need to configure the server url a To open a pad for editing try ~M-x etherpad-edit~ and enter the name of the pad. -To update a pad with changes from the current buffer use ~etherpad-save~ (add a keybinding if required). If the pad has changed there may be a warning about changes/sync/etc. +To update a pad with changes from the current buffer use ~etherpad-save~ (which can be bound to ~C-c c~). If the pad has changed there may be a warning about changes/sync/etc. Automatic sync between an emacs buffer and the etherpad server can be enabled by setting ~etherpad-autosync~ or interactively with ~etherpad-autosync-enable~ or ~etherpad-autosync-disable~ (and/or toggled with ~etherpad-autosync-toggle~) diff --git a/etherpad.el b/etherpad.el index 9253fcc..5217a04 100644 --- a/etherpad.el +++ b/etherpad.el @@ -1,4 +1,4 @@ -;;; etherpad.el --- etherpad API -*- coding: utf-8; lexical-binding: t -*- +;;; etherpad.el --- Interface to the Etherpad API -*- coding: utf-8; lexical-binding: t -*- ;; Copyright 2020 FoAM ;; @@ -6,8 +6,8 @@ ;; Created: 2020-08-08 ;; Version: 0.1 ;; Package-Requires: ((emacs "26.1") (request "0.3") (let-alist "0.0")) -;; Keywords: etherpad, collaborative editing, -;; URL: https://github.com/zzkt/etherpad-emacs +;; Keywords: comm, etherpad, collaborative editing +;; URL: https://github.com/zzkt/ethermacs ;; This file is not part of GNU Emacs.