Added README

Author: Jason Duncan

.gitignore

@@ -1,3 +1,4 @@
+*~
 *.elc
 *.log
 *.html

README.org

@@ -0,0 +1,34 @@
+* dashboard-project-status
+Display a git project status in a dashboard widget.
+
+If magit is installed, a link to the project in magit will be provided as well.
+
+** Installation / Usage
+
+*** use-package
+
+#+begin_src emacs-lisp
+(use-package dashboard
+  :config
+  (use-package dashboard-project-status
+   :config
+    (add-to-list 'dashboard-item-generators
+                 `(project-status . ,(dashboard-insert-project-status *your directory*)))
+    (add-to-list 'dashboard-items '(project-status) t))
+  (dashboard-setup-startup-hook))
+#+end_src
+
+*** Without use-package
+
+#+begin_src emacs-lisp
+;; some time before calling `dashboard-setup-startup-hook':
+(reqiure 'dashboard-project-status)
+(add-to-list 'dashboard-item-generators
+  `(project-status . ,(dashboard-insert-project-status *your directory*)))
+(add-to-list 'dashboard-items '(project-status) t)
+#+end_src
+
+*** Auto-Refresh Project
+Setting the optional second argument UPDATE to `dashboard-insert-project-status'
+non-nil will cause the project to be refreshed automatically using
+"git remote update".

dashboard-project-status.el

@@ -24,6 +24,8 @@
 
 ;; Display a git project status in a dashboard widget.
 
+;; See README.org for installation and usage.
+
 ;;; Code:
 
 (require 'git)