Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix grammar issues and typos #337

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@
- [ ] I have added/updated relevant documentation/screenshots (if applicable).
- [ ] I have included tests (if applicable).
- [ ] I have labeled the PR appropriately with `Feature`, `Improvement`, `Bug` or `New Project`
- [ ] My branch is up to date with the main branch.
- [ ] My branch is up-to-date with the main branch.
- [ ] The PR has a meaningful title and description.
10 changes: 10 additions & 0 deletions .idea/runConfigurations.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion submissions/Chisend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The bot is written in Python and uses the [Tweepy](https://www.tweepy.org/) libr
It uses the pychimoney library to send the chimoney.

## How to use
- Follow the bot on twitter
- Follow the bot on Twitter
- Tweet the bot with the following format
- @chisendtest send amount to @username
- The bot will you a direct message for confirmation and checkout
Expand Down
2 changes: 1 addition & 1 deletion submissions/GetStarted/Blogs.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h2>introduction to Chimoney</h2>
method</p>
<b>Endpoints:</b>
<p>Get list of all supported airtime Countries. <h5>https://api.chimoney.io/v0.2/info/airtime-countries</h5>
<p>Get list of all assests. <h5>https://api.chimoney.io/v0.2/info/assets</h5>
<p>Get list of all assets. <h5>https://api.chimoney.io/v0.2/info/assets</h5>
<p>Get list of Supported banks and bank code. <h5>https://api.chimoney.io/v0.2/info/country-banks</h5>
<p>Get list of bank branches and branch code. <h5>https://api.chimoney.io/v0.2/info/bank-branches</h5>
<p>get exchange rates. <h5>https://api.chimoney.io/v0.2/info/exchange-rates</h5>
Expand Down
2 changes: 1 addition & 1 deletion submissions/chiconnect-bank-api-payout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A mini project to demonstrate integration of Chiconnect bank api payout using Re

## Commit style guidelines

A commit message should easily convey what it contains so this guidelines shows a commit should be for this project.
A commit message should easily convey what it contains so the guidelines show a commit should be for this project.

The commit message should be in this format `type: subject` where `type` can be any one of these:

Expand Down
2 changes: 1 addition & 1 deletion submissions/chiconnect-giftcard-payout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A mini project to demonstrate integration of Chiconnect giftcard payout using Re

## Commit style guidelines

A commit message should easily convey what it contains so this guidelines shows a commit should be for this project.
A commit message should easily convey what it contains so the guidelines show a commit should be for this project.

The commit message should be in this format `type: subject` where `type` can be any one of these:

Expand Down
2 changes: 1 addition & 1 deletion submissions/chiconnect-mobile-money-payout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A mini project to demonstrate integration of Chiconnect mobile money api payout

## Commit style guidelines

A commit message should easily convey what it contains so this guidelines shows a commit should be for this project.
A commit message should easily convey what it contains so the guidelines show a commit should be for this project.

The commit message should be in this format `type: subject` where `type` can be any one of these:

Expand Down
2 changes: 1 addition & 1 deletion submissions/chimap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Run development server:
npm run dev
```

## Enviroment Variables
## Environment Variables
For development server, create file ".env.local" in project root folder and add the following

NEXT_PUBLIC_MAPBOX_KEY
Expand Down
2 changes: 1 addition & 1 deletion submissions/chimoney-discord-bot/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The /send_chimoney command sends X amount of funds to Y user

## Deployment

The Chimoney bot is current hosted on a heroku server, however this poses some issues
The Chimoney bot is currently hosted on a heroku server, however this poses some issues
as heroku's web processes timeout after a few minutes of inactivity. The bot cannot be deployed on a
heroku worker as it uses a http server to listen for webhook events.

Expand Down
2 changes: 1 addition & 1 deletion submissions/chimoney-github-bot/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# chimoney-github-bot

> A GitHub App built with [Probot](https://github.com/probot/probot) that facilitates sponsoring github contributors using the chimoney API
> A GitHub App built with [Probot](https://github.com/probot/probot) that facilitates sponsoring GitHub contributors using the chimoney API

## Setup

Expand Down
2 changes: 1 addition & 1 deletion submissions/chimoney-payout-airtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Run the following commands in the project directory
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

## Screenshots of the the project
## Screenshots of the project
<img src="assets/example-1.png" alt="screenshot" title="screenshot">

<img src="assets/example-2.png" alt="screenshot" title="screenshot">
Expand Down
4 changes: 2 additions & 2 deletions submissions/chimoney-redeem-airtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.


## Screenshots of the the project
## Screenshots of the project
<img src="assets/screenshot-1.PNG" alt="screenshot" title="screenshot">

<img src="assets/screenshot-2.PNG" alt="screenshot" title="screenshot">

## Screenshots of the the Redeemed Airtime
## Screenshots of the Redeemed Airtime
<img src="assets/text-msg.jpg" alt="text-message" title="text-message">
<img src="assets/text-msg-2.jpg" alt="text-message" title="text-message">

Expand Down
2 changes: 1 addition & 1 deletion submissions/pay-paddy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ React web app that utilizes most of Chiconnect api endpoints to enable a variety

## Commit style guidelines

A commit message should easily convey what it contains so this guidelines shows a commit should be for this project.
A commit message should easily convey what it contains so the guidelines show a commit should be for this project.

The commit message should be in this format `type: subject` where `type` can be any one of these:

Expand Down
2 changes: 1 addition & 1 deletion submissions/whatsapp-bot-node/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ Replace `@username` with the recipient's Telegram username and `amount` with the

### Receiving Chimoney

When you receive Chimoney, the bot will send recipient a mesage with a link to claim the Chimoney.
When you receive Chimoney, the bot will send recipient a message with a link to claim the Chimoney.