Improve README
This commit is contained in:
parent
5c281cf9ef
commit
876edfc0d7
29
README.md
29
README.md
|
@ -9,7 +9,6 @@ Accept donations in Discourse! Integrates with [Stripe](https://stripe.com).
|
|||
* Be sure your site is enforcing https.
|
||||
* Follow the install instructions here: https://meta.discourse.org/t/install-a-plugin/19157
|
||||
* Add your Stripe public and private keys in settings and set the currency to your local value.
|
||||
* Add the following script to your page header in a custom theme component: `<script src="https://js.stripe.com/v3/"></script>`
|
||||
* Enable the plugin and wait for people to donate money.
|
||||
|
||||
## Creating new user accounts
|
||||
|
@ -53,34 +52,6 @@ Card numbers in **bold** have beed tested.
|
|||
* **4000 0000 0000 0119** Charge is declined with a processing_error code.
|
||||
* 4242 4242 4242 4241 Charge is declined with an incorrect_number code as the card number fails the Luhn check.
|
||||
|
||||
## Markup
|
||||
|
||||
Stripe checkout forms to be added to forum posts using markup:
|
||||
|
||||
#### Example
|
||||
|
||||
[stripe amount=999 image=/img/someImage.png]
|
||||
Widget
|
||||
[/stripe]
|
||||
|
||||
|
||||
Which renders as:
|
||||
|
||||
<form action="" method="POST">
|
||||
<script
|
||||
src="https://checkout.stripe.com/checkout.js"
|
||||
class="stripe-button"
|
||||
data-key="pk_test_6pRXXX"
|
||||
data-amount="999"
|
||||
data-name="Your Shop"
|
||||
data-description="Widget"
|
||||
data-image="/img/someImage.png"
|
||||
data-locale="auto">
|
||||
</script>
|
||||
</form>
|
||||
|
||||
Site settings can be used to configure the various fields
|
||||
|
||||
## Warranty
|
||||
|
||||
This software comes with no warranty of any kind.
|
||||
|
|
Loading…
Reference in New Issue