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.

Sign up for GitHub

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: Corrected all the grammatical errors and typos in README.md #4615

Merged
merged 4 commits into from
Oct 23, 2023
Merged

docs: Corrected all the grammatical errors and typos in README.md #4615

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22d3055
Updated README.md
alienishi Oct 22, 2023
38b009d
Merge branch 'next' into next
djabarovgeorge Oct 23, 2023
5e09714
Updated README.md
alienishi Oct 23, 2023
346e200
Updated README.md
alienishi Oct 23, 2023
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ The ultimate service for managing multi-channel notifications with a single API.
<br /><br />
<h1 align="center">🎉 We're participating in Hacktoberfest 2023! 🎉</h1>

Interested in participating in Hacktoberfest? We extend a warm invitation! You also get the opportunity to win some swag 😁
Are you interested in participating in Hacktoberfest? We extend a warm invitation! You also get the opportunity to win some swag 😁

> ⭐️ If you're new to Hacktoberfest, you can learn more and register to participate [here](https://hacktoberfest.com/participation/). Registration is from **September 26th - October 31st**.

- Our Hacktoberfest kickoff event is happening on October 2, 2023. 🚀
- Check out our website for [hacktoberfest instructions](https://novu.co/hacktoberfest/).
- Join our [Discord and engage with our community](https://discord.com/invite/novu), get answers to your challenges, stay updated on events, announcements & prizes.
- Join our [Discord and engage with our community](https://discord.com/invite/novu), get answers to your challenges, and stay updated on events, announcements, and prizes.

In addition to this repository, here are the other Novu repositories you can contribute to for Hacktoberfest:
- [Novu Docs](https://github.com/novuhq/docs/issues)
Expand Down Expand Up @@ -81,7 +81,7 @@ With Novu, you can create custom workflows and define conditions for each channe
- 📦 Easy to set up and integrate
- 🛡 Debug and analyze multi-channel messages in a single dashboard
- 📦 Embeddable notification center with real-time updates
- 👨‍💻 Community driven
- 👨‍💻 Community-driven

## 📚 Table Of Contents

Expand All @@ -100,15 +100,15 @@ With Novu, you can create custom workflows and define conditions for each channe

## 🚀 Getting Started

We are excited to launch the complete Novu API and admin panel. Want to give it a test before the official release? Here is how:
We are excited to launch the complete Novu API and admin panel. Do you want to give it a test before the official release? Here is how:

```
npx novu init
```

After setting up your account using the cloud or docker version, you can trigger the API using the `@novu/node` package.

For API documentation and reference, please visit [Novu API Reference](https://docs.novu.co/api-reference/events/trigger-event).
For API documentation and reference, please visit [Novu API Reference] (https://docs.novu.co/api-reference/events/trigger-event).

To get started with the Node.js package, you can install it using npm:

Expand Down Expand Up @@ -224,11 +224,11 @@ Novu provides a single API to manage providers across multiple channels with a s

## 📋 Read Our Code Of Conduct

Before you begin coding and collaborating, please read our [Code of Conduct](https://github.com/novuhq/novu/blob/main/CODE_OF_CONDUCT.md) thoroughly to understand the standards (that you are required to adhere to) for community engagement. As part of our open-source community, we hold ourselves and other contributors to a high standard of communication. As a participant and contributor to this project, you are agreeing to abide by our [Code of Conduct](https://github.com/novuhq/novu/blob/main/CODE_OF_CONDUCT.md).
Before you begin coding and collaborating, please read our [Code of Conduct](https://github.com/novuhq/novu/blob/main/CODE_OF_CONDUCT.md) thoroughly to understand the standards (that you are required to adhere to) for community engagement. As part of our open-source community, we hold ourselves and other contributors to a high standard of communication. As a participant and contributor to this project, you agree to abide by our [Code of Conduct](https://github.com/novuhq/novu/blob/main/CODE_OF_CONDUCT.md).

## 💻 Need Help?

We are more than happy to help you. If you are getting any errors or facing problems while working on this project, join our [Discord server](https://discord.novu.co) and ask for help. We are open to discuss anything related to the project.
We are more than happy to help you. If you are getting any errors or facing problems while working on this project, join our [Discord server](https://discord.novu.co) and ask for help. We are open to discussing anything related to the project.

## ⚡ Immediate working space with Gitpod

Expand Down