lingo: import README

combo/apps/lingo/README

@@ -0,0 +1,45 @@
+Lingo
+=====
+
+Lingo is an extension module for the combo content management system, adding
+basket and payment features.
+
+License
+-------
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
+details.
+
+You should have received a copy of the GNU Affero General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+API
+---
+
+Items amount can be added to basket through API by posting to
+*/api/lingo/add-basket-item* endpoint a json payload containing *amount* and/or
+*"extra": {"amount": ...}* attribute or passing *amount* in the query string
+
+For example:
+
+    {"display_name": "<item display name>",
+     "url": "http://<item url>",
+     "amount": "42.42",
+     "extra": {"amount": "10.42", ...},
+     ...
+     }
+
+or
+    /api/lingo/add-basket-item?amount=10
+
+The "amount" attribute should be float or decimal or a list of
+floats/decimals. For example:
+
+    {"amount": [14.12], "extra": {"amount": ["10.42", "5", "10"], ... }, ...}