diff --git a/INSTALL.md b/INSTALL.md index 2a851ba4..3de309dd 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,22 +1,8 @@ # Install Open Source Event Manager -This file contains all the information you need to install OSEM. If you run into any problems, do not hesitate to [contact us](https://github.com/openSUSE/osem#contact). - -If you encounter -``` -An error occurred while installing yajl-ruby (1.2.0), and Bundler cannot continue. -Make sure that `gem install yajl-ruby -v '1.2.0'` succeeds before bundling. -``` -or - -``` -An error occurred while installing json (1.8.3), and Bundler cannot continue. -Make sure that `gem install json -v '1.8.3'` succeeds before bundling. -``` - -check that your Ruby version is not greater than `ruby-2.3.3`. +All the information that you need to install OSEM. If you have any problems with installing don't hesitate to [contact us](https://github.com/openSUSE/osem#contact) ## Versions -OSEM is a [semantic versioned](http://semver.org/) app. That means given a version number MAJOR.MINOR.PATCH we increment the: +OSEM is an [semantic versioned](http://semver.org/) app. That means given a version number MAJOR.MINOR.PATCH we increment the: 1. MAJOR version when we make incompatible changes, 2. MINOR version when we add functionality in a backwards-compatible manner @@ -26,11 +12,11 @@ OSEM is a [semantic versioned](http://semver.org/) app. That means given a versi You can find the latest OSEM releases on our [release page](https://github.com/openSUSE/osem/releases/latest) ([older release here](https://github.com/openSUSE/osem/releases)) ## Deploy -OSEM is a *Ruby on Rails* application. We recommend you run OSEM in production with [mod_passenger](https://www.phusionpassenger.com/download/#open_source) -and the [apache web-server](https://www.apache.org/). There are tons of guides on how to deploy rails apps on various +OSEM is a *Ruby on Rails* application. We recommend to run OSEM in production with [mod_passenger](https://www.phusionpassenger.com/download/#open_source) +and the [apache web-server](https://www.apache.org/). There are tons of guides on how to deploy Rails apps on various base operating systems. [Check Google](https://encrypted.google.com/search?hl=en&q=ruby%20on%20rails%20apache%20passenger) ;-) -For more information about Fails and what it can do, see the [Fails Guides.](http://guides.rubyonrails.org/getting_started.html) +For more information about Rails and what it can do, see the [Rails Guides.](http://guides.rubyonrails.org/getting_started.html) If you have a Heroku account you can also @@ -69,8 +55,8 @@ There are a couple of environment variables you can set to configure OSEM. | STRIPE_SECRET_KEY | *string* | Secret Key for Stripe Gateway ### Online Ticket Payments -We use [Stripe](https://stripe.com) for accepting ticket payments securely over the web. -Our application uses iFrame for accepting your users' payment details without storing them, making the application PCI SAQ-A Compliant. +We use [Stripe](https://stripe.com) for accepting your ticket payments securely over the web. +Our application uses iFrame for accepting your user's payment details without storing them, making the application PCI SAQ-A Compliant. Please refer to [PAYMENTS](PAYMENTS.md) documentation file for setting up your stripe account and start accepting payments from your users. ## Dependencies diff --git a/PAYMENTS.md b/PAYMENTS.md index d835e1c0..91ab0fba 100644 --- a/PAYMENTS.md +++ b/PAYMENTS.md @@ -1,5 +1,5 @@ # Integrate your Stripe account to accept your user's payments -Here you will find all the information you need to setup your Stripe account into OSEM. +Here you will find all the information that you need to setup your Stripe account into OSEM. If you have any problems with installing don't hesitate to [contact us](https://github.com/openSUSE/osem#contact) ## Configure Stripe into the application @@ -34,9 +34,9 @@ As we are using Stripe Checkout for accepting payments, Stripe will help you for You can read the full security documentation [here](https://stripe.com/docs/security). ## Configure Stripe to send emails for successful transactions -Stripe can send email reciepts for every successful payment done through its gateway. +Stripe can send email receipts for every successful payment done through its gateway. Please refer [here](https://dashboard.stripe.com/account/emails) to enable invoice emails for your users. ## Customize Stripe invoice emails for your application -You can customise your payment reciepts by adding your personalisation like organisation name, logo etc. +You can customise your payment receipts by adding your personalisation like organisation name, logo etc. Please see the options for invoice personalisation [here](https://dashboard.stripe.com/account/public).