Docker support for Tramp.

Slightly modified copy of ‘tramp-nspawn’.

1 files changed, 28 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..f9a4988
--- /dev/null
+++ b/README.org
@@ -0,0 +1,28 @@
+* Introduction
+=tramp-docker= adds support for =Docker= containers with Emacs’
+Tramp system.
+
+* Installation
+** ELPA
+This package is available on [[https://elpa.gnu.org/packages/nspawn-tramp.html][GNU ELPA]] and can be installed with
+=M-x package-install RET tramp-docker RET= from within Emacs itself.
+
+** Direct download
+Download this repository to some location, then add the following to
+your Emacs initialization:
+#+begin_src elisp
+  (add-to-list 'load-path "/path/to/tramp-docker")
+  (require 'tramp-docker)
+#+end_src
+
+* Usage
+Call ~tramp-docker-setup~ to add support:
+#+begin_src elisp
+  (add-hook 'after-init-hook 'tramp-docker-setup)
+#+end_src
+
+
+Use Tramp as normal to access files on a container:
+#+begin_example
+  C-x C-f /docker:user@container:/path/to/file
+#+end_example