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

update README.md file to include general and testing APIs #31

Merged
merged 5 commits into from
Jan 10, 2024

Conversation

narekhovhannisyan
Copy link
Collaborator

Motivation

Update Readme.md doc file to mention General API and Testing API.

Changes

  • Updated Readme.md file.

@narekhovhannisyan narekhovhannisyan changed the title docs: update README.md file and include general and testing APIs. update README.md file to include general and testing APIs Dec 24, 2023
README.md Show resolved Hide resolved
README.md Outdated

### Nodemailer Transport

> NOTE: [Nodemailer](https://www.npmjs.com/package/nodemailer) is needed as a dependency.

```sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably leave installation steps here, and just replace code example with a link 🙏

  • Reading installation steps in Readme would be more comfortable

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, updating

@narekhovhannisyan narekhovhannisyan merged commit 89866d8 into main Jan 10, 2024
1 check passed
@narekhovhannisyan narekhovhannisyan deleted the docs-update branch January 10, 2024 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants