Skip to content

Commit

Permalink
Merge pull request #6 from OAyomide/update-readme
Browse files Browse the repository at this point in the history
πŸ“ update readme and lib.rs
  • Loading branch information
OAyomide authored May 23, 2021
2 parents 5f38854 + 0675f5b commit 2134324
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 23 deletions.
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,37 @@
# Paystack-rs

A rust crate that wraps around the paystack REST API. [WIP]. Not ready for use yet.
A rust crate that wraps around the paystack REST API.

## Whats working and whats yet to be done?

Currently, there are methods for every transactions endpoint. Anything apart from that is not ready yet. I recently started working on it and since I have a full-time job that takes my time, I basically just try to write like a few minutes or an hour a day of open-source code and this is one. Therefore, I still have a lot of things to do.

Some things to be done (Endpoints) are:
APIs that have been implemented are:

- [x] Transactions
- [x] Transactions splits
- [x] Customers
- [x] Dedicated NUBAN
- [ ] Subaccounts
- [ ] Plans
- [ ] Subscription
- [ ] Products
- [ ] Payment pages
- [ ] Invoices
- [ ] Settlement
- [ ] Transfer recipients
- [ ] Transfers
- [ ] Transfers Control
- [ ] Bulk Charges
- [ ] Control Panel
- [ ] Charge
- [ ] Dispute
- [x] Subaccounts
- [x] Plans
- [x] Subscription
- [x] Products
- [x] Payment pages
- [x] Invoices
- [x] Settlement
- [x] Transfer recipients
- [x] Transfers
- [x] Transfers Control
- [x] Bulk Charges
- [x] Control Panel
- [x] Charge
- [x] Dispute
- [x] Refunds
- [ ] Verifications
- [ ] Miscellaneous
- [x] Verifications
- [x] Miscellaneous

Other things are:

- [ ] Tests (i know!! tests are important! πŸ™ƒ)
- [ ] Support reading Bearer access token and similar sensitive information from .env file
- [ ] Proper comments and documentation

## How to use

Expand Down
21 changes: 19 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
mod paystack;
mod utils;
pub mod prelude {
pub use crate::paystack::refund::*;
pub use crate::paystack::bulk_charges::*;
pub use crate::paystack::charge::*;
pub use crate::paystack::control_panel::*;
pub use crate::paystack::customers::*;
pub use crate::paystack::customers::*;
pub use crate::paystack::dedicated_nuban::*;
pub use crate::paystack::disputes::*;
pub use crate::paystack::invoices::*;
pub use crate::paystack::miscellaneous::*;
pub use crate::paystack::payment_pages::*;
pub use crate::paystack::plans::*;
pub use crate::paystack::products::*;
pub use crate::paystack::refund::*;
pub use crate::paystack::settlements::*;
pub use crate::paystack::subaccounts::*;
pub use crate::paystack::subscription;
pub use crate::paystack::transactions::*;
pub use crate::paystack::transactions_split::*;
pub use crate::paystack::transfer_recipients::*;
pub use crate::paystack::transfers;
pub use crate::paystack::transfers_control::*;
pub use crate::paystack::verification::*;
pub use crate::paystack::Paystack;
// pub use crate::utils::*;
}

0 comments on commit 2134324

Please sign in to comment.