aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2012-05-22 17:36:14 +1200
committerTom Ryder <tom@sanctum.geek.nz>2012-05-22 17:36:14 +1200
commitb66f49f20e42afb48755c58725d70344a5c7eb07 (patch)
treebedb1d5460ebb43b72778b1dcc3c4b9159abc7ab
parentSpecify this is a Vim plugin. (diff)
downloadvim-vawk-b66f49f20e42afb48755c58725d70344a5c7eb07.tar.gz
vim-vawk-b66f49f20e42afb48755c58725d70344a5c7eb07.zip
New README.md file.
-rw-r--r--README21
-rw-r--r--README.md17
2 files changed, 17 insertions, 21 deletions
diff --git a/README b/README
deleted file mode 100644
index b962441..0000000
--- a/README
+++ /dev/null
@@ -1,21 +0,0 @@
-vawk - Awk wrapper and shorthand functions for Vim
-
-Author: Tom Ryder <tom@sanctum.geek.nz>
-License: Same terms as Vim itself
-
-Work with Awk-friendly columnar data. Provides a simple wrapper to Awk as well
-as a few useful functions for chopping and changing columnar data. Requires
-Awk to be installed, of course.
-
-All commands accept a range which defaults to the entire file. For commands
-which accept columns, these should be comma-separated; you can also use ranges
-as a shorthand, e.g. 1,3-6,10,11.
-
-:[range]Vawk <script> Run an arbitrary Awk script.
-
-:[range]Vcut <columns> Delete the columns specified.
-
-:[range]Vonly <columns> Delete all columns except for the specified.
-
-g:vawksep The record separator to use for the data.
- Defaults to Awk's usual whitespace delimiting.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..915bca0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+Vawk
+====
+
+Work with Awk-friendly columnar data in Vim. Provides a simple wrapper to Awk as well as a few useful functions for chopping and changing columnar data. Requires Awk to be installed, of course.
+
+All commands accept a range which defaults to the entire file. For commands which accept columns, these should be comma-separated; you can also use ranges as a shorthand, e.g. `1,3-6,10,11`.
+
+* `:[range]Vawk <script>` -- Run an arbitrary Awk script.
+* `:[range]Vcut <columns>` -- Delete the columns specified.
+* `:[range]Vonly <columns>` -- Delete all columns except for the specified.
+* `g:vawksep` -- The record separator to use for the data. Defaults to Awk's usual whitespace delimiting.
+
+License
+-------
+
+Copyright (c) [Tom Ryder](http://www.sanctum.geek.nz/about/tom-ryder/). Distributed under the same terms as Vim itself. See `:help license`.
+