[UPD] readme file

hotel_calendar/README.rst

@@ -0,0 +1,61 @@
+.. This file is going to be generated by oca-gen-addon-readme. Manual changes will be overwritten.
+
+HOTEL CALENDAR
+==============
+This module allows you to handle reservations, prices and restriction plans in a user friendly calendar view.
+
+Description
+------------
+This module extends the functionality of roomdoo.
+
+The calendar displays your rooms in a range of dates.
+The rooms can be filtered by class, type or even amenities creating new calendars for easily manage all your reservations.
+You can manage prices and restrictions day by day using the calendar management view.
+
+This module adds two new view types: ``pms`` and ``mpms``.
+The module also incorporates a longpolling for delivering instant notification when using the calendar.
+
+Installation
+------------
+This module depends on modules ``hotel``, ``bus``, ``web``, ``calendar``, and ``web_widget_color``.
+Ensure yourself to have all them in your addons list.
+
+Configuration
+-------------
+No action required. The module is pre-configured with default values.
+
+You will find the hotel calendar settings in `Settings > Users & Companies > Hotels > Your Hotel > Calendar Settings Tab`.
+
+Reservation colors can be configured by company in `Settings > Users & Companies > Companies > Your Company > Hotel Preferences Tab.`
+
+Usage
+-----
+To use this module, you need to:
+
+* Go to Hotel Calendar menu for managing reservations.
+* Go to Hotel Calendar Management for managing prices and restrictions.
+* Go to Hotel Management/Configuration/Calendars menu for managing calendar tabs.
+
+Shortcuts
+_________
+* ``CTRL + LEFT MOUSE CLICK`` on a reservation - start reservation swap
+* ``ESC``  - cancel active action (ie. swap)
+
+
+Credits
+-------
+
+Authors
+_______
+- Alexandre Díaz <dev@redneboa.es>
+
+Contributors
+____________
+* Pablo Quesada <pabloqb@gmail.com>
+
+Roadmap
+-------
+* [ ] Implement the calendar view as an Odoo native view type.
+* [ ] Re-design the calendar using SVG or other Odoo native approach.
+
+Do you want to contribute? Please, do not hesitate to contact any of the authors or contributors.