[TASK] restructuring README.md
authorIvan Kartolo <ivan.kartolo@gmail.com>
Thu, 18 Feb 2016 22:24:11 +0000 (23:24 +0100)
committerIvan Kartolo <ivan.kartolo@gmail.com>
Thu, 18 Feb 2016 22:24:11 +0000 (23:24 +0100)
Change-Id: If3802d3d9922b6fd59af478a2da97f1e5507c9e2

README.md [new file with mode: 0644]
README.txt [deleted file]
upgrade.txt [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..cfda47b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Direct Mail Subscription
+
+This is a simple subscription formular for the [TYPO3 CMS](http://typo3.org).
+
+This extension depends on following extension:
+
+1. [direct_mail](https://typo3.org/extensions/repository/view/direct_mail)
+2. [tt_address](https://typo3.org/extensions/repository/view/tt_address)
+
+
+Any question, you can find some help in the TYPO3 Slack
+
+https://typo3.slack.com/messages/direct_mail
+   
+To join the slack channel, please request for invitation from https://forger.typo3.org/slack
+
+## Contributing
+
+You can contribute to this project by reporting any issue you found here in github or on https://forge.typo3.org/projects/extension-direct_mail_subscription/
+
+You can also contributing any code by:
+
+1. Fork the repository on Github
+2. Clone repository
+3. Make your changes
+4. Commit your changes to your fork. In your commit message refer to the issue number if there is already one, e.g. `[BUGFIX] short description of fix (resolves #4711)`
+5. Submit a Pull Request using GitHub (here are some hints on [How to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request))
\ No newline at end of file
diff --git a/README.txt b/README.txt
deleted file mode 100644 (file)
index 6e40ce1..0000000
+++ /dev/null
@@ -1,6 +0,0 @@
-Upon upgrading, please notes these changes:
-       - TypoScript is moved to static template. Please include this manually
-       - fe_adminLib.inc is now local. please check the path to this script in your TypoScript.
-       - new subpart in template ###TEMPLATE_INFOMAIL_NORECORD###
-       - added support for captcha. Please check the standard TypoScript in ext_typoscript_setup.txt
-       -
\ No newline at end of file
diff --git a/upgrade.txt b/upgrade.txt
new file mode 100644 (file)
index 0000000..6e40ce1
--- /dev/null
@@ -0,0 +1,6 @@
+Upon upgrading, please notes these changes:
+       - TypoScript is moved to static template. Please include this manually
+       - fe_adminLib.inc is now local. please check the path to this script in your TypoScript.
+       - new subpart in template ###TEMPLATE_INFOMAIL_NORECORD###
+       - added support for captcha. Please check the standard TypoScript in ext_typoscript_setup.txt
+       -
\ No newline at end of file