-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from chamindias/monetization-dev-master
Add instructions into README.md.
- Loading branch information
Showing
1 changed file
with
32 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,32 @@ | ||
# wso2-am-stripe-plugin | ||
# Stripe Extension For WSO2 API Manager | ||
|
||
The Stripe extension for WSO2 API Manager allows you to integrate Stripe as the billing engine for monetizing APIs. | ||
|
||
This is a sample implementation to support usage based billing for a API subscription. | ||
|
||
## Compatibility | ||
|
||
| Stripe Extension Version | Supported WSO2 APIM Version | | ||
| :-------------: | :---------------:| | ||
| [1.0.0](https://github.com/wso2-extensions/wso2-am-stripe-plugin/tree/v1.0.0) | API Manager 3.0.0 | ||
|
||
|
||
## Getting Started | ||
|
||
### Using The Stripe Extension | ||
|
||
To get started with Stripe extension and it's operations, see [configuring API monetization](https://apim.docs.wso2.com/en/next/Learn/APIMonetization/monetizing-an-api/). | ||
|
||
### Building From The Source | ||
|
||
Follow the steps given below to build the Stripe extension from the source code: | ||
|
||
1. Get a clone or download the source from [Github](https://github.com/wso2-extensions/wso2-am-stripe-plugin). | ||
2. Run the following maven command inside the `wso2-am-stripe-plugin` directory. | ||
>`mvn clean install` | ||
3. The Stripe extension jar file is created in the `wso2-am-stripe-plugin/target` directory. | ||
|
||
### How You Can Contribute | ||
|
||
As an open source project, WSO2 extensions welcome contributions from the community. | ||
Check the [issue tracker](https://github.com/wso2-extensions/wso2-am-stripe-plugin/issues) for open issues that interest you. We look forward to receiving your contributions. |