Skip to content

Commit

Permalink
Merge pull request #3 from rofazayn/v2.0.0-stable
Browse files Browse the repository at this point in the history
feat: release v2.0.0-stable and update lib name
  • Loading branch information
rofazayn authored Mar 10, 2024
2 parents 188daaa + a9f96c4 commit 65722bb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,22 @@ The Chargily Pay JavaScript Library offers a convenient way to integrate the Cha

To include this library in your project, you can use npm or yarn:

`npm install @chargily/pay`
```shell
npm install @chargily/chargily-pay
```

or

`yarn add @chargily/pay`
```shell
yarn add @chargily/chargily-pay
```

## Getting Started

Before utilizing the library, you must configure it with your [Chargily API key](https://dev.chargily.com/pay-v2/api-keys) and specify the mode (test or live). Here's an example to get started:

```ts
import { ChargilyClient } from '@chargily/pay';
import { ChargilyClient } from '@chargily/chargily-pay';

const client = new ChargilyClient({
api_key: 'YOUR_API_KEY_HERE',
Expand Down Expand Up @@ -413,11 +417,11 @@ This returns a paginated list of all payment links you've created.

## Final Notes

This documentation covers the basic functionality of the `@chargily/pay` library. For more advanced features and comprehensive details, refer to the official [Chargily Pay API documentation](https://dev.chargily.com/pay-v2/introduction).
This documentation covers the basic functionality of the `@chargily/chargily-pay` library. For more advanced features and comprehensive details, refer to the official [Chargily Pay API documentation](https://dev.chargily.com/pay-v2/introduction).

By integrating the `@chargily/pay` library into your project, you're equipped to seamlessly incorporate Chargily's payment gateway, enhancing your application's payment processing capabilities.
By integrating the `@chargily/chargily-pay` library into your project, you're equipped to seamlessly incorporate Chargily's payment gateway, enhancing your application's payment processing capabilities.

If you encounter any issues or have further questions, please visit our [GitHub repository](https://github.com/chargily/@chargily/pay) to report issues or seek guidance.
If you encounter any issues or have further questions, please visit our [GitHub repository](https://github.com/chargily/chargily-pay-javascript) to report issues or seek guidance.

Happy coding!

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@chargily/pay",
"version": "0.0.1-alpha",
"name": "@chargily/chargily-pay",
"version": "2.0.0",
"description": "JavaScript Library for Chargily Pay™ Gateway - V2. The easiest and free way to integrate e-payment API through EDAHABIA of Algerie Poste and CIB of SATIM into your JS project.",
"main": "lib/index.js",
"types": "lib/index.d.ts",
Expand Down

0 comments on commit 65722bb

Please sign in to comment.