Initial Commit

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..07b1271
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# bitutils
+A collection of small, single-purpose scripts written in POSIX shell and awk
+for the manipulation of bibtex database files from the command line. Each one
+is small and single purpose. They are as follows:
+
+## bib-util
+A general wrapper script that centralizes the functionality of many of the
+smaller provided scripts for convenience's sake.
+
+## bib-add
+A script for inserting a new entry into a bibtex database file. It will
+accept a fully formatted entry on standard input and add it to a database
+file presented as an argument.
+
+## bib-gen
+A script which generates a bibtex entry based on input. By default it will
+run in an interactive mode, prompting the user to enter the relevant details.
+Additionally, it can be configured to read the data directly from stdin based
+on format arguments, or data can be provided directly as arguments. The
+formatted bibtex entry will be emitted on stdout.
+
+## bib-extract 
+A script which filters a bibtex database provided on stdin or as an argument
+and emits only those entries contained within a specified aux file.
+
+## bib-key
+A script which accepts a bibtex entry on stdin, and emits it on stdout with
+an automatically generated bibtex key.
+
+## bib-fetch
+A script which accepts a pdf file as an input argument and will attempt to
+fetch a corresponding bibtex entry from crossref.org based on its DOI, if
+one is available.