[nongnu] elpa/org-auto-tangle a92a19a760 03/56: added README.org

[ELPA Syncer]

branch: elpa/org-auto-tangle
commit a92a19a76044c8d35ac6f9f8e355bfff90c0a8ed
Author: lispy-dobby <yilkalargawworkneh@gmail.com>
Commit: lispy-dobby <yilkalargawworkneh@gmail.com>

    added README.org
---
 README.org | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..2e4e3f8038
--- /dev/null
+++ b/README.org
@@ -0,0 +1,30 @@
+#+title: org-auto-tangle
+#+author: Yilkal Argaw
+
+* Introduction
+
+This package (i.e org-auto-tangle) is a very simple emacs package that
+allows you to automatically tangle org files on save. This is done by
+adding the option ~#+auto_tangle: t~ in your org file.
+
+The tangling process happens asynchronously so it will not block your
+emacs session.
+
+* USAGE 
+
+Simply require the package in you emacs init.
+
+#+begin_src 
+
+(require 'org-auto-tangle)
+  
+#+end_src
+
+You can turn this behaviour on and off though the
+~org-auto-tangle-tangle-on-save~  variable. If the value is non nil it
+is on it will try to automatically tangle your org files if they
+contain a non nil value for the ~#+auto_tangle:~ option.
+
+* License
+
+The org-auto-tangle is licensed under the The 2-Clause BSD License.