Skip to content

Commit

Permalink
Merge pull request #54 from amosmachora/refactor/re-introduce-docs
Browse files Browse the repository at this point in the history
(refactor) : re-introduce docs
  • Loading branch information
amosmachora authored Oct 4, 2024
2 parents dc6d5ae + a8bb7a0 commit 4925ef9
Show file tree
Hide file tree
Showing 84 changed files with 7,655 additions and 11,312 deletions.
3 changes: 2 additions & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
"ignore": [],
"packages": ["packages/main-lib"]
}
6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ jobs:
- uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
with:
version: 8
version: 9
- uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: 20.x
cache: "pnpm"

- run: pnpm install --frozen-lockfile
- run: pnpm run lint && pnpm run build
- run: pnpm run lint && pnpm --filter daraja-kit run build
3 changes: 3 additions & 0 deletions CONTIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing to Daraja Kit

Welcome to Daraja Kit! We're excited that you're interested in contributing. Before you start, please follow the guidelines below.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# React Daraja
# Daraja Kit

Improving the Developer Experience of using the Safaricom daraja API.

![image info](./public/full-logo.png)

# About

React Daraja is a typesafe Javascript library designed to simplify interactions with the Safaricom Daraja API. This library is suitable for both Node.js and React environments, allowing developers to seamlessly integrate M-Pesa payments into their applications.
Daraja Kit is a typesafe Javascript library designed to simplify interactions with the Safaricom Daraja API. This library is suitable for both Node.js and React environments, allowing developers to seamlessly integrate M-Pesa payments into their applications.

## Installation

To install React Daraja, run the following command in your project's terminal:
To install Daraja Kit, run the following command in your project's terminal:

```bash
npm install daraja-kit
Expand Down Expand Up @@ -50,7 +50,7 @@ The library throws errors if any of this values are missing from your .env file.

## Compatibility

React Daraja is compatible with Node.js and React environments. It provides a simple interface for initiating M-Pesa transactions using the Safaricom Daraja API.
Daraja Kit is compatible with Node.js and React environments. It provides a simple interface for initiating M-Pesa transactions using the Safaricom Daraja API.

Some APIs are exclusively for Node Environments and some are just React Components so are only used in react.

Expand Down
47 changes: 0 additions & 47 deletions contributing.md

This file was deleted.

Loading

0 comments on commit 4925ef9

Please sign in to comment.