[IMP] shell: README

shell/README.md

@@ -1,22 +0,0 @@
-Makes available in Odoo 8 the `shell` server command available for Odoo 9.
-
-To have this feature available this module just need to be in the
-addons path. To use it, in a terminal window run:
-
-    $ ./odoo.py shell -d <dbname>
-
-This will initialize a server instance and then jump into a Pyhton
-interactive shell, with full access to the Odoo API.
-
-Example session:
-
-    >>> self
-    res.users(1,)
-    >>> self.name
-    u'Administrator'
-    >>> self._name
-    'res.users'
-    >>> self.env
-    <openerp.api.Environment object at 0xb3f4f52c>
-    >>> self.env['res.partner'].search([('name', 'like', 'Ag')])
-    res.partner(7, 51)

shell/README.rst

@@ -0,0 +1,63 @@
+CLI shell for Odoo
+==================
+
+Makes available in Odoo 8 the `shell` server command available for Odoo 9.
+
+Installation
+============
+
+Just install the module.
+
+Configuration
+=============
+
+Nothing special to be configured.
+
+Usage
+=====
+
+To have this feature available this module just need to be in the
+addons path. To use it, in a terminal window run:
+
+    $ ./odoo.py shell -d <dbname>
+
+This will initialize a server instance and then jump into a Pyhton
+interactive shell, with full access to the Odoo API.
+
+Example session:
+
+    >>> self
+    res.users(1,)
+    >>> self.name
+    u'Administrator'
+    >>> self._name
+    'res.users'
+    >>> self.env
+    <openerp.api.Environment object at 0xb3f4f52c>
+    >>> self.env['res.partner'].search([('name', 'like', 'Ag')])
+    res.partner(7, 51)
+
+
+Credits
+=======
+
+Contributors
+------------
+
+* OpenERP S.A.
+* Daniel Reis <dgreis@sapo.pt>
+
+Maintainer
+----------
+
+.. image:: http://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: http://odoo-community.org
+
+This module is maintained by the OCA.
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+To contribute to this module, please visit http://odoo-community.org.