README.md in razorpay-1.2.0 vs README.md in razorpay-1.2.1
- old
+ new
@@ -51,14 +51,14 @@
For other applications (such as fetching payments and refunds),
see our online documentation on <https://docs.razorpay.com>
### Orders API
-Send us a mail at <support@razorpay.com> to enable the Orders API
-for your account. You can use the orders API using the following
-constructs:
+You can use the orders API using the following constructs:
+You can find docs at <https://docs.razorpay.com/v1/page/orders>
+
```rb
order = Razorpay::Order.create amount: 5000, currency: 'INR', receipt: 'TEST'
# order.id = order_50sX9hGHZJvjjI
# Same collection as Refunds or Payments
@@ -68,12 +68,21 @@
order = Razorpay::Order.fetch('order_50sX9hGHZJvjjI')
puts order.amount
# Fetching payments corresponding to an order
payments = order.payments
+
+# Create a customer
+customer = Razorpay::Customer.create email: 'test@razorpay.com', contact: '9876543210'
+puts customer.id #cust_6vRXClWqnLhV14
+
+# Creating an invoice
+invoice = Razorpay::Invoice.create customer_id: customer.id, amount: 100, currency: 'INR', description: 'Test description', type: 'link'
```
+You can find invoices API documentation at <https://docs.razorpay.com/v1/page/invoices>.
+
## Development
- Everything is namespaced under the Razorpay module
- We use rubocop for checking style guidelines
- Rake + MiniTest is using as the testrunner
@@ -88,5 +97,21 @@
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Run `rake` and `rubocop` after making your changes to make sure you didn't break anything
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
+
+## Release
+
+Steps to follow for a release:
+
+0. Merge the branch with the new code to master.
+1. Bump the Version in `lib/razorpay/constants.rb`
+2. Rename Unreleased to the new tag in `CHANGELOG`
+3. Fix links at bottom in `CHANGELOG`
+4. Commit (message should include version number)
+5. Tag the release and push to GitHub. Get the tag signed using Razorpay GPG key.
+6. Create a release on GitHub using the website with more details about the release
+7. Run `gem build razorpay-ruby.gemspec`
+8. Run `gem push razorpay-{version}.gem`
+
+`gem push` will ask you for credentials, if you are not logged in already.