diff --git a/README.md b/README.md index 149a54f..038f93d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,35 @@ -

M-Pesa Logo

- -# Pesa SDK for Nodejs using M-Pesa Open API - -![npm (scoped)](https://img.shields.io/npm/v/@openpesa/pesa-js) -[![Build Status](https://travis-ci.org/openpesa/pesa-js.svg)](https://travis-ci.org/openpesa/pesa-js) -![documentation](https://github.com/openpesa/pesa-js/workflows/documentation/badge.svg) -[![NPM](https://nodei.co/npm/@openpesa/pesa-js.png?mini=true)](https://npmjs.org/package/@openpesa/pesa-js) - -The **Pesa SDK for Node.js** makes it easy for developers to access [OpenAPI](https://openapiportal.m-pesa.com/) in their Javascript code, and build robust applications and software using services like Customer 2 Bussiness, Query, etc. - -## Documentation +

Node pesa

+ +

+ + npm (scoped) + + + NPM + +

+ +

+ + + node pesa + +

Integration that simplifies access to M-Pesa's OpenAPI for developers to build applications/ software by providing easy access to services like Customer to Business (C2B), Query, and more.

+

+

+ +

+ Report Bug + Β· + Request Feature +

+ +## 🚧 Documentation Take a look at the [API docs here](https://openpesa.github.io/pesa-js/). -## Getting Started + +## πŸš€ Getting Started 1. **Sign up for OpenAPI Portal** – Before you begin, you need to sign up for an account and retrieve your credentials. @@ -32,11 +48,10 @@ Take a look at the [API docs here](https://openpesa.github.io/pesa-js/). 1. **Using the SDK** – The best way to become familiar with how to use the SDK is to read the [User Guide](https://openpesa.github.io/pesa-js/). -## Usage - -### Quick Examples +## πŸ’Ό Usage ```js + import { Pesa } from '@openpesa/pesa-js'; // Populate the credentials @@ -61,19 +76,18 @@ pesa.c2b(data) .catch((e) => { console.log('err: ' + e); }); + ``` -### Testing +## πŸ§ͺ Test ```bash -npm test -``` -## Opening Issues +npm test -If you have a feature request or you encounter a bug, please file an issue on [our issue tracker on GitHub](https://github.com/openpesa/pesa-js/issues). +``` -## Road Map +## πŸ—ΊοΈ Road Map 1. Validate data input using Regex before the API call. 2. If fields are not provided then generate a random string for "input_ThirdPartyConversationID" and "input_TransactionReference" @@ -82,18 +96,23 @@ If you have a feature request or you encounter a bug, please file an issue on [o 5. Validate Secret Keys length and format. 6. Allow user use custom sessionID on any/each transaction. (Portal allow for seesion with several hours of validity) 7. Add and improve documentation and examples(example will include expressjs app) -8. +## πŸ“œ Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## 🀝 Contributing + +Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. -### Security +## πŸ” Security Vulnerabilities -If you discover any security-related issues, please email [alphaolomi@gmail.com](mailto:alphaolomi@gmail.com) instead of using the issue tracker. +Please review [our security policy](../../security/policy) on how to report security vulnerabilities. -## Credits +## πŸ‘₯ Credits -- [Openpesa](https://github.com/openpesa) - [All Contributors](../../contributors) -## License +## πŸ“„ License The MIT License (MIT). Please see [License File](LICENSE.md) for more information. diff --git a/img/banner/header-dark.png b/img/banner/header-dark.png new file mode 100644 index 0000000..36c6343 Binary files /dev/null and b/img/banner/header-dark.png differ diff --git a/img/banner/header-light.png b/img/banner/header-light.png new file mode 100644 index 0000000..ac4d61d Binary files /dev/null and b/img/banner/header-light.png differ diff --git a/img/mpesa.png b/img/mpesa.png deleted file mode 100644 index 216246c..0000000 Binary files a/img/mpesa.png and /dev/null differ