Merge pull request #39 from yelizariev/8.0-mail_recovery-doc

[DOC] add docs for mail_recovery

mail_recovery/README.rst

@@ -2,7 +2,12 @@
  Mail Recovery
 ===============
 
-Save and recover message from localStorage if it was not sent
+Backup and recover unsent message. It works via localStorage.
+
+TODO
+====
+
+* add support for *full mail composer*
 
 Credits
 =======
@@ -18,10 +23,12 @@ Sponsors
 Further information
 ===================
 
+Demo: http://runbot.it-projects.info/demo/mail-addons/8.0
+
 HTML Description: https://apps.odoo.com/apps/modules/8.0/mail_recovery/
 
-.. Usage instructions: `<doc/index.rst>`_
+Usage instructions: `<doc/index.rst>`_
 
-.. Changelog: `<doc/changelog.rst>`_
+Changelog: `<doc/changelog.rst>`_
 
-Tested on Odoo 8.0 2ff993ff8cff94bdc568f8579000f2f10b32c810
+Tested on Odoo 8.0 17a130428516d9dd8105f90e8c9a65a0b4e8901b

mail_recovery/__openerp__.py

@@ -1,10 +1,13 @@
 # -*- coding: utf-8 -*-
 {
     'name': "Mail recovery",
+    'summary': """Backup and recover unsent message""",
     'author': "IT-Projects LLC, Ildar Nasyrov",
     'license': 'GPL-3',
+    "price": 190.00,
+    "currency": "EUR",
     'website': "https://twitter.com/nasyrov_ildar",
-    'category': 'Uncategorized',
+    'category': 'Discuss',
     'version': '1.0.0',
     'depends': ['mail'],
     'data': [

mail_recovery/doc/changelog.rst

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+`1.0.0`
+-------
+
+- Init version

mail_recovery/doc/index.rst

@@ -0,0 +1,11 @@
+===============
+ Mail recovery
+===============
+
+Usage
+=====
+
+* Start typing new message
+* Force close browser window or tab
+* Click on message input
+* The message is recovered

mail_recovery/static/description/index.html

@@ -0,0 +1,80 @@
+<section class="oe_container">
+    <div class="oe_row oe_spaced">
+        <div class="oe_span12">
+            <h2 class="oe_slogan">Mail recovery</h2>
+            <h3 class="oe_slogan">Backup and recover unsent message</h3>
+        </div>
+    </div>
+</section>
+
+<section class="oe_container oe_dark">
+    <div class="oe_row oe_spaced">
+        <div class="oe_span4">
+            <p class="oe_mt32">
+                Imagine that you are typing a message to someone. Probably a big message.
+            </p>
+        </div>
+        <div class="oe_span8">
+            <div class="oe_row_img oe_centered">
+                <img class="oe_demo oe_picture oe_screenshot" src="typing.png"/>
+            </div>
+        </div>
+    </div>
+</section>
+
+<section class="oe_container">
+    <div class="oe_row oe_spaced">
+
+        <div class="oe_span8">
+            <div class="oe_row_img oe_centered">
+                <img class="oe_demo oe_picture oe_screenshot" src="black.png"/>
+            </div>
+        </div>
+
+        <div class="oe_span4">
+            <p class="oe_mt32">
+                And then something wrong happens. You close browser, electricity is turned off or whatever.
+            </p>
+        </div>
+    </div>
+</section>
+
+<section class="oe_container oe_dark">
+    <div class="oe_row oe_spaced">
+        <div class="oe_span4">
+            <p class="oe_mt32">
+                Don't worry! Open browser again and click Reply icon. 
+            </p>
+        </div>
+
+        <div class="oe_span8">
+            <div class="oe_row_img oe_centered">
+                <img class="oe_demo oe_picture oe_screenshot" src="reopen.png"/>
+            </div>
+        </div>
+
+        <div class="oe_span4">
+            <p class="oe_mt32">
+                You can finish your message from point where it was interrupted.
+            </p>
+        </div>
+        <div class="oe_span8">
+            <div class="oe_row_img oe_centered">
+                <img class="oe_demo oe_picture oe_screenshot" src="continue.png"/>
+            </div>
+        </div>
+    </div>
+</section>
+
+<section class="oe_container">
+    <div class="oe_row oe_spaced">
+        <div class="oe_span12">
+            <h2>Need our service?</h2>
+            <p class="oe_mt32">Contact us by <a href="mailto:it@it-projects.info">email</a> or fill out <a href="https://www.it-projects.info/page/website.contactus " target="_blank">request form</a></p>
+            <ul>
+                <li><a href="mailto:it@it-projects.info">it@it-projects.info <i class="fa fa-envelope-o"></i></a></li>
+                <li><a href="https://www.it-projects.info/page/website.contactus " target="_blank">https://www.it-projects.info/page/website.contactus <i class="fa fa-list-alt"></i></a></li>
+            </ul>
+        </div>
+    </div>
+</section>