diff --git a/README.md b/README.md index 1a47a50..1dd3782 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,31 @@ -## Payments +# Payments -Payments app for frappe +A payments app for frappe. -#### License +## Installation +1. Install [bench & frappe](https://frappeframework.com/docs/v14/user/en/installation). -MIT \ No newline at end of file +2. Once setup is complete, add the payments app to your bench by running + ``` + $ bench get-app payments + ``` +3. Install the payments app on the required site by running + ``` + $ bench --site install-app payments + ``` + +## App Structure & Details +App has 2 modules - Payments and Payment Gateways. + +Payment Module contains the Payment Gateway DocType which creates links for the payment gateways and Payment Gateways Module contain all the Payment Gateway (Razorpay, Stripe, Braintree, Paypal, PayTM) DocTypes. + +All general utils are stored in [utils](payments/utils) directory. The utils are written in [utils.py](payments/utils/utils.py) and then imported into the [`__init__.py`](payments/utils/__init__.py) file for easier importing/namespacing. + +[overrides](payments/overrides) directory has all the overrides for overriding standard frappe code. Currently it overrides WebForm DocType controller as well as a WebForm whitelisted method. + +[templates](payments/templates) directory has all the payment gateways' custom checkout pages. + +# + +## License +MIT ([license.txt](license.txt)) diff --git a/license.txt b/license.txt index 2fdf7c7..6919960 100644 --- a/license.txt +++ b/license.txt @@ -1 +1,21 @@ -License: MIT \ No newline at end of file +The MIT License + +Copyright (c) 2016-2021 Frappe Technologies Pvt. Ltd. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE.