From 5a3ac1aa6bb924c54ce635fc2a8ba11801a2e082 Mon Sep 17 00:00:00 2001 From: Tatsuo Kaniwa Date: Fri, 19 Apr 2013 10:42:11 +0900 Subject: [PATCH] update docs --- LICENSE | 22 ++++++++++++++++++++++ README.md | 38 +++++++++++++++++++++++++++++++++++++- 2 files changed, 59 insertions(+), 1 deletion(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0a6fbed --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +The MIT License + +Copyright (c) 2013 Tatsuo Kaniwa + +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. \ No newline at end of file diff --git a/README.md b/README.md index 4da5382..e7d50f9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,40 @@ GMO ==== -GMO is a Node.js client library for the GMO Payment Platform, supporting the PG Multi Payment API, exec transactions, register users, and so on. \ No newline at end of file +GMO is a Node.js client library for the GMO Payment Platform, supporting the PG Multi Payment API, exec transactions, register users, and so on. + +Installation +--- + +```bash +npm install gmo +``` + +Usage +--- + +```coffeescript +gmo = require "gmo" + +shopApi = new gmo.ShopAPI( + host: "hoge.mul-pay.jp" + shop_id: "shop_id" + shop_pass: "shop_pass" +) + +option = + order_id: order_id + job_cd: "AUTH" + amount: "100" + +shopApi.entryTran option , (err, res) -> + if err + console.log err + if res + console.log res + +``` + +Contributors +--- +Patches contributed by [those people](https://github.com/t-k/gmo-payment-node/contributors). \ No newline at end of file