]> code.delx.au - gnu-emacs-elpa/commitdiff
Improve the README, add old screenshots
authorDmitry Gutov <dgutov@yandex.ru>
Wed, 13 Mar 2013 21:13:55 +0000 (01:13 +0400)
committerDmitry Gutov <dgutov@yandex.ru>
Wed, 13 Mar 2013 21:13:55 +0000 (01:13 +0400)
README.md
screenshots/company-cpp.png [new file with mode: 0644]
screenshots/company-elisp.png [new file with mode: 0644]

index ff48917c175030cf3b07fa32df0b8673bdf9aa4c..af9d28bfbe2a775c49e08939f5877cb6bc3e3041 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,47 @@
-Company is an Emacs extension for performing text completion.\r
-Completion candidates are retrieved from a variety of modular\r
-back-ends, such as Semantic.\r
-\r
-Once installed, enable company-mode with <kbd>M-x company-mode</kbd>.\r
-For further information, see the docstring for `company-mode`.\r
+Company Mode
+====
+
+About
+----
+
+Company is an Emacs extension for performing text completion.
+Completion candidates are retrieved from a variety of modular
+back-ends, such as `abbrev`, `Semantic`, `Eclim`, `etags`, etc.
+
+Screenshots
+----
+
+[<img src="screenshots/company-elisp.png" alt="company-elisp" width="256/>](screenshots/company-elisp.png)
+[<img src="screenshots/company-cpp.png" alt="company-cpp" width="256/>](screenshots/company-cpp.png)
+
+Installation
+----
+
+This package is part of [GNU ELPA](http://elpa.gnu.org/) (<kbd>M-x
+list-packages</kbd>).
+
+Usage
+----
+
+Once installed, enable company-mode with <kbd>M-x company-mode</kbd>.
+
+Completion will start automatically after you type a few letters. Use
+<kbd>M-n</kbd>, <kbd>M-p</kbd>, <kbd><tab></kbd> and <kbd><return></kbd> to
+complete. Search through the completions with <kbd>C-s</kbd>, <kbd>C-r</kbd> and
+<kbd>C-o</kbd>.
+
+To use `company-mode` is all buffers, add the following to your init file:
+
+    (global-company-mode)
+
+To set up preferred back-ends, customize `company-backends`.
+
+Also see this variable's docstring for information on writing a back-end.
+
+For more information, see the docstring for `company-mode`.
+
+Feedback
+----
+
+If you experience any problems or have a feature request, use the
+[Issue Tracker](https://github.com/dgutov/company/issues).
diff --git a/screenshots/company-cpp.png b/screenshots/company-cpp.png
new file mode 100644 (file)
index 0000000..c2817ba
Binary files /dev/null and b/screenshots/company-cpp.png differ
diff --git a/screenshots/company-elisp.png b/screenshots/company-elisp.png
new file mode 100644 (file)
index 0000000..c87c994
Binary files /dev/null and b/screenshots/company-elisp.png differ