Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.69 KB

README.md

File metadata and controls

57 lines (42 loc) · 2.69 KB
Raw

Floobits plugin for Emacs

Real-time collaborative editing. Think Etherpad, but with native editors. This is the plugin for Emacs. We also have plugins for Sublime Text, Vim, and IntelliJ.

Development status: Reasonably stable. We've tested it on Emacs 24 and later. Earlier versions probably won't work. This plugin requires Python 2.7 or later.

Installation

MELPA

If you have MELPA, simply M-x package-install <RET> floobits <RET>

el-get

If you have el-get, simply M-x el-get-install <RET> floobits <RET>. To keep everything up to date, you can add the following line to your ~/.emacs:

(el-get-update-all 1)

Manual installation

  • cd ~/.emacs.d/
  • git clone https://github.com/Floobits/floobits-emacs.git floobits
  • Add Floobits to your ~/.emacs: (load "~/.emacs.d/floobits/floobits.el")

Initial set-up

{
  "auth": {
    "floobits.com": {
      "username": "your_username",
      "api_key": "your_api_key",
      "secret": "your_api_secret_not_your_password"
    }
  }
}

Usage

All commands are documented in apropos-command <RET> floobits

  • M-x floobits-join-workspace <RET> https://floobits.com/owner/workspace/ <RET>   Join an existing floobits workspace.
  • M-x floobits-share-dir-private <RET> DIR <RET>   Create a workspace and populate it with the contents of the directory, DIR (or make it).
  • M-x floobits-share-dir-public <RET> DIR <RET>   Create a workspace and populate it with the contents of the directory, DIR (or make it).
  • M-x floobits-leave-workspace <RET>   Leave the current workspace.
  • M-x floobits-summon <RET>   Summon everyone in the workspace to your cursor position.
  • M-x floobits-follow-mode-toggle <RET>   Toggle following of recent changes.
  • M-x floobits-clear-highlights <RET>   Clears all mirrored highlights.

Help

If you have trouble setting up or using this plugin, please contact us.