Commits

Robert Massaioli [Atlassian] committed 2f5661c

Wrote a basic readme file.

Comments (0)

Files changed (2)

README

-You have successfully created a plugin using the JIRA plugin archetype!
-
-Here are the SDK commands you'll use immediately:
-
-* atlas-run   -- installs this plugin into JIRA and starts it on http://localhost:2990/jira
-* atlas-debug -- same as atlas-run, but allows a debugger to attach at port 5005
-* atlas-cli   -- after atlas-run or atlas-debug, opens a Maven command line window:
-                 - 'pi' reinstalls the plugin into the running JIRA instance
-* atlas-help  -- prints description for all commands in the SDK
-
-Full documentation is always available at:
-
-https://developer.atlassian.com/display/DOCS/Developing+with+the+Atlassian+Plugin+SDK
+# PingMe Plugin for JIRA
+
+Sometimes you wanted to be notified of an issue and have it brought to your attention in X days.
+This plugin makes that happen and closes the notification loop in many common situations in JIRA.
+
+## To run the plugin...
+
+You have successfully created a plugin using the JIRA plugin archetype!
+
+Here are the SDK commands you'll use immediately:
+
+* atlas-run   -- installs this plugin into JIRA and starts it on http://localhost:2990/jira
+* atlas-debug -- same as atlas-run, but allows a debugger to attach at port 5005
+* atlas-cli   -- after atlas-run or atlas-debug, opens a Maven command line window:
+                 - 'pi' reinstalls the plugin into the running JIRA instance
+* atlas-help  -- prints description for all commands in the SDK
+
+Full documentation is always available at:
+
+https://developer.atlassian.com/display/DOCS/Developing+with+the+Atlassian+Plugin+SDK