Basic files

diff --git a/.dir-locals.el b/.dir-locals.el
new file mode 100644 (file)
index 0000000..79d9a12
--- /dev/null
+++ b/.dir-locals.el
@@ -0,0 +1,4 @@
+((nil . ((indent-tabs-mode . nil)
+         (fill-column . 80)
+         (sentence-end-double-space . t)
+         (emacs-lisp-docstring-fill-column . 75))))

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..2ecd291
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+*.elc
+ert.el

diff --git a/README.md b/README.md
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/README.org b/README.org
new file mode 100644 (file)
index 0000000..80f04d7
--- /dev/null
+++ b/README.org
@@ -0,0 +1,23 @@
+* company-statistics
+** About
+Company-statistics is a global minor mode built on top of the in-buffer
+completion system [[http://company-mode.github.io/][company-mode]].  The idea is to keep a log of a certain number
+of completions you choose, along with some context information, and use that to
+rank candidates the next time you have to choose --- hopefully showing you
+likelier candidates at the top of the list.
+** Use It
+Using the package is simple.  With the files in your =load=path=, add to your
+=init.el= file
+#+begin_src emacs-lisp
+(require 'company-statistics)
+(company-statistics-mode)
+#+end_src
+to load the package and turn on the mode.  See the (few but powerful)
+customizable options for details =M-x customize-group company-statistics=.
+** Design
+Company-statistics relies on company-mode (it works by adding a function to
+company-transformers), but is only loosely coupled to it.  It is designed with
+some flexibility in mind as for the recorded context information and the way
+candidates are scored: the default pair of functions are only examples!  The
+stats are automatically persistent between sessions.
+** Have Fun!